wp-mapit / readme.txt

readme.txt in WP MapIt 2.2, at readme.txt

141 lines 5.3 KB

Raw Download Zip

1	=== WP MapIt ===
2	Contributors: chandnipatel
3	Donate link: https://www.paypal.me/chandnipatel11
4	Tags: wp mapit, maps, map, map marker, map pin, wordpress maps, open street maps, leaflet, free map, map plugin, wp map, no api, map widget, map shortcode, map gutenberg, open source map, osm, open street map, mapit
5	Requires at least: 4.2
6	License: GPL3
7	Tested up to: 5.3
8	Requires PHP: 5.4
9	Stable tag: trunk
10
11	Easy to use, WordPress Map plugin based on Open Street Map and Leaflet with custom markers images, descriptions and links.
12
13
14	== Description ==
15	Easy to use, WordPress Map plugin based on Open Street Map and Leaflet with custom markers images, descriptions and links. Add maps to your WordPress pages, posts and custom post types quickly and easily.
16
17	Display map automatically before or after content, or place the map within the page content using gutenberg block, shortcode or widget.
18
19	Choose your own images to display as markers. Decide what happens on marker click, display a popup or open a link.
20
21
22	== Free Version ==
23	* Display Open Street Maps using Leaflet on your WordPress.
24	* Super easy to use, no coding required.
25	* No API keys required to display maps on your WordPress website.
26	* Interactive map preview.
27	* Search a location to add pin.
28	* Preview all the changes on the fly in admin panel.
29	* Click map to add page markers. Drag markers to the exact location.
30	* Use custom images as map pins to give your map a personalized touch.
31	* Define your height and width and zoom level for the map.
32	* Decide what happens on marker click. Open a popup or redirect to a URL.
33	* Add maps to custom post types.
34	* Responsive maps.
35	* Display multiple maps on a single page.
36	* Display map in the sidebar.
37	* Gutenberg blocks to display map within the content.
38	* Map widget functionality.
39	* Shortcode functionality.
40	* Maps with multiple Marker.
41	* Hooks and filters.
42	* Note: Grayscale is not supported in IE apart from IE Edge.
43
44	== Demos ==
45	* [Map before content.](http://wp-mapit.chandnipatel.in/demos/map-before-content/)
46	* [Map after content.](http://wp-mapit.chandnipatel.in/demos/map-after-content/)
47	* [Map within content.](http://wp-mapit.chandnipatel.in/demos/custom-map-within-content/)
48	* [Map in the sidebar.](http://wp-mapit.chandnipatel.in/demos/custom-map-sidebar/)
49	* [Map with multiple pins.](http://wp-mapit.chandnipatel.in/demos/map-with-multiple-pins/)
50	* [Hooks & Filters.](http://wp-mapit.chandnipatel.in/documentation/hooks-filters/)
51
52
53	== Documentation ==
54	* [Installing WP MapIt plugin.](http://wp-mapit.chandnipatel.in/documentation/installing-wp-mapit-plugin/)
55	* [Setting up the plugin.](http://wp-mapit.chandnipatel.in/documentation/setting-up-the-plugin/)
56	* [Displaying map on the page.](http://wp-mapit.chandnipatel.in/documentation/displaying-map-on-the-page/)
57	* [Creating a multipin map.](http://wp-mapit.chandnipatel.in/documentation/creating-a-multi-pin-map/)
58
59
60	== Installation ==
61	To install this plugin:
62
63	Uploading the plugin from WordPress dashboard
64	* Download the plugin from the WordPress repository
65	* Go to WordPress Dashboard
66	* Click on Plugins menu
67	* Click on Add New
68	* Click on Upload Plugin
69	* Select the plugin zip file and click Install Now button
70	* Once the plugin is installed, click on Activate link to activate the plugin.
71
72	Uploading the plugin using FTP
73	* Download the plugin from the WordPress repository
74	* Go to wp-content/plugin in your WordPress root directory
75	* Unzip and upload the plugin
76	* Go to Plugins in WordPress dashboard
77	* Locate “WP MapIt” plugin in the list
78	* Click on Activate link to activate the plugin
79
80	== Frequently Asked Questions ==
81
82	= Is the map free? =
83	Yes, open source Open street maps are used to display the Map instead of google maps which is free.
84
85	= Do I need an API? =
86	No. API is not required to display the map on the site.
87
88	= I have installed the plugin, now what? =
89	[Check out how to set up the plugin and add a map.](http://wp-mapit.chandnipatel.in/documentation/installing-wp-mapit-plugin/)
90
91	= Does grayscale map work on IE? =
92	It works in IE Edge, it is not supported in the versions below it.
93
94	== Screenshots ==
95	1. Settings page.
96	2. Adding map to page / post.
97	3. Map displayed before content.
98	4. Map displayed after content.
99	5. WP MAPIT Gutenberg block.
100	6. WP MAPIT Gutenberg block added in the editor.
101	7. Shortcode to display map in page / post.
102	8. WP MAPIT Wiget.
103	9. Adding map with multiple marker.
104	10. Adding map pin to map with multiple marker.
105	11. Map displayed with multiple pins.
106
107	== Credits ==
108	* [Leaflet](https://leafletjs.com/)
109	* [Open Street Maps](https://www.openstreetmap.org/)
110	* [Yet Another Fred](https://github.com/yafred/leaflet-responsive-popup)
111	* [elmarquis](https://github.com/elmarquis/Leaflet.GestureHandling)
112	* [Veith Schoergenhummer](https://www.linkedin.com/in/vschoerg/)
113
114	== Changelog ==
115	= 1.1 :- 2019-04-09 :- Medium priority =
116	* Added Gesture handling
117
118	= 1.2 :- 2019-06-03 :- High priority =
119	* Bugs resolution
120
121	= 2.0 :- 2019-06-06 :- Medium priority =
122	* Added map with multiple pins.
123
124	= 2.1 :- 2019-09-12 :- Medium priority =
125	* Added hooks and filters for plugin extension.
126
127	= 2.2 :- 2019-09-12 :- High priority =
128	* Bug resolution for grayscale issue in IE Edge.
129
130	== Upgrade Notice ==
131	= 1.1 =
132	Please update to 1.1 as it includes Gesture handling.
133
134	= 2.0 =
135	Please update to 2.0 as it includes maps with multiple pins.
136
137	= 2.1 =
138	Please update to 2.1 as it includes hooks and filters for plugin extension.
139
140	= 2.2 =
141	Solved grayscale issue for IE Edge.