Skip to content

Commit b1a30f2

Browse files
author
Joe Hawes
committed
Updated readme
1 parent a4b0e78 commit b1a30f2

File tree

3 files changed

+33
-9
lines changed

3 files changed

+33
-9
lines changed

inc/Admin/Waymark_Settings.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1020,7 +1020,7 @@ function __construct() {
10201020

10211021
'title' => esc_html__('Marker Clustering', 'waymark'),
10221022
'default' => Waymark_Config::get_setting('misc', 'cluster_options', 'show_cluster'),
1023-
'tip' => esc_attr__('Whether to cluster (group) Markers that are close together. Pro Tip! This will affect all Maps, but you can also enable/disable clustering through the Shortcode: [Waymark show_cluster="0"]', 'waymark'),
1023+
'tip' => esc_attr__('Whether to cluster (stack) Markers that are close together. Pro Tip! This will affect all Maps, but you can also enable/disable clustering through the Shortcode: [Waymark show_cluster="0"]', 'waymark'),
10241024
),
10251025
'cluster_threshold' => array(
10261026
'name' => 'cluster_threshold',

readme.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Features:
2222
* Easy to use, customisable and developer friendly.
2323
* Use the <a href="https://www.waymark.dev/docs/editor/">Editor</a> to create Maps containing Overlays (Markers, Lines and Shapes).
2424
* Every Overlay can be given a title, image and description; which is displayed once the Overlay is clicked.
25-
* Set styles and options once using <a href="https://www.waymark.dev/docs/types/">Types</a>, then simply select the appropriate Type when adding an Overlay. Lines can display arrows to indicate direction.
25+
* Set styles and options once using <a href="https://www.waymark.dev/docs/types/">Types</a>, then simply select the appropriate Type when adding an Overlay.
26+
* <a href="https://www.waymark.dev/docs/marker-clustering/">Marker Clustering</a> and Line direction arrows supported.
2627
* Add Maps to your content using the Waymark <a href="https://www.waymark.dev/docs/shortcodes/">Shortcode</a>, or link to the <a href="https://www.waymark.dev/map/route-map/">Map Details</a> page.
2728
* <a href="https://www.openstreetmap.org/fixthemap">OpenStreetMap</a> is the default <a href="https://www.waymark.dev/docs/basemaps/">Basemap</a>, with support for multiple Basemaps.
2829
* Images uploaded with location data (EXIF) will have a Marker placed where the photo was taken.
@@ -45,12 +46,23 @@ With Waymark enabled, click on the "Maps" link in the sidebar to create and edit
4546

4647
### Is There a Demo? ###
4748

48-
Yes, <a href="https://www.waymark.dev/demo/">here</a>.
49+
Yes, <a href="https://www.waymark.dev/demo/">here</a>. You can also try the Editor <a href="https://www.waymark.dev/try/">here</a>.
4950

5051
### Can I Get More Help? ###
5152

5253
Yes, please view the <a href="https://www.waymark.dev/docs/">Documentation</a>.
5354

55+
### How Can I Contribute? ###
56+
57+
* [Star the project on GitHub](https://github.com/morehawes/Waymark/)
58+
* [Report bugs](https://wordpress.org/support/plugin/waymark/#new-topic-0)
59+
* [Suggest new features](https://wordpress.org/support/plugin/waymark/#new-topic-0)
60+
* [Translate the plugin](https://translate.wordpress.org/projects/wp-plugins/waymark/)
61+
* [Rate the plugin](https://wordpress.org/support/plugin/waymark/reviews/#new-post)
62+
* Share with anyone that will listen how much you like Waymark :)
63+
64+
If you have anything bad to say, please <a href="https://wordpress.org/support/plugin/waymark/#new-topic-0">get in touch</a> before leaving a review, so I can try to fix it.
65+
5466
### Does Waymark Support Google Maps? ###
5567

5668
While Google Basemaps can be added to Waymark, Waymark does not use the Google Maps API (it uses <a href="https://leafletjs.com/">Leaflet</a>). There are other plugins available that are made specifically for Google Maps.
@@ -116,8 +128,8 @@ A big thank you to the following projects and their contributors. Without their
116128

117129
### 0.9.30 ###
118130

119-
* **Marker Clustering**
120-
* Once enabled, Markers will be grouped together when they are close together. This can help to reduce clutter on the Map.
131+
* **<a href="https://www.waymark.dev/docs/marker-clustering/">Marker Clustering</a>**
132+
* Once enabled, Markers will be stacked when they are close together. This can help to reduce clutter on the Map.
121133
* You can enable this feature in Settings > Maps > Clustering, or using the `show_cluster="1"` Shortcode option.
122134
* There are also settings to adjust the cluster radius and what what zoom level to start clustering at.
123135
* Added `file_start_type` and `file_end_type` options to the <a href="https://www.waymark.dev/docs/shortcodes/#shortcode-files">Shortcode Files</a> feature, which allow you to automatically add a Marker of the specified type to the start and/or end of all Lines in the file. Thanks to <a href="https://wordpress.org/support/users/digbymaass/">digbymaass</a> for the <a href="https://wordpress.org/support/topic/shortcode-option-for-start-marker/">suggestion</a>.

readme.txt

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ Features:
2424
* Easy to use, customisable and developer friendly.
2525
* Use the <a href="https://www.waymark.dev/docs/editor/">Editor</a> to create Maps containing Overlays (Markers, Lines and Shapes).
2626
* Every Overlay can be given a title, image and description; which is displayed once the Overlay is clicked.
27-
* Set styles and options once using <a href="https://www.waymark.dev/docs/types/">Types</a>, then simply select the appropriate Type when adding an Overlay. Lines can display arrows to indicate direction.
27+
* Set styles and options once using <a href="https://www.waymark.dev/docs/types/">Types</a>, then simply select the appropriate Type when adding an Overlay.
28+
* <a href="https://www.waymark.dev/docs/marker-clustering/">Marker Clustering</a> and Line direction arrows supported.
2829
* Add Maps to your content using the Waymark <a href="https://www.waymark.dev/docs/shortcodes/">Shortcode</a>, or link to the <a href="https://www.waymark.dev/map/route-map/">Map Details</a> page.
2930
* <a href="https://www.openstreetmap.org/fixthemap">OpenStreetMap</a> is the default <a href="https://www.waymark.dev/docs/basemaps/">Basemap</a>, with support for multiple Basemaps.
3031
* Images uploaded with location data (EXIF) will have a Marker placed where the photo was taken.
@@ -49,12 +50,23 @@ With Waymark enabled, click on the "Maps" link in the sidebar to create and edit
4950

5051
= Is There a Demo? =
5152

52-
Yes, <a href="https://www.waymark.dev/demo/">here</a>.
53+
Yes, <a href="https://www.waymark.dev/demo/">here</a>. You can also try the Editor <a href="https://www.waymark.dev/try/">here</a>.
5354

5455
= Can I Get More Help? =
5556

5657
Yes, please view the <a href="https://www.waymark.dev/docs/">Documentation</a>.
5758

59+
= How Can I Contribute? =
60+
61+
* [Star the project on GitHub](https://github.com/morehawes/Waymark/)
62+
* [Report bugs](https://wordpress.org/support/plugin/waymark/#new-topic-0)
63+
* [Suggest new features](https://wordpress.org/support/plugin/waymark/#new-topic-0)
64+
* [Translate the plugin](https://translate.wordpress.org/projects/wp-plugins/waymark/)
65+
* [Rate the plugin](https://wordpress.org/support/plugin/waymark/reviews/#new-post)
66+
* Share with anyone that will listen how much you like Waymark :)
67+
68+
If you have anything bad to say, please <a href="https://wordpress.org/support/plugin/waymark/#new-topic-0">get in touch</a> before leaving a review, so I can try to fix it.
69+
5870
= Does Waymark Support Google Maps? =
5971

6072
While Google Basemaps can be added to Waymark, Waymark does not use the Google Maps API (it uses <a href="https://leafletjs.com/">Leaflet</a>). There are other plugins available that are made specifically for Google Maps.
@@ -100,8 +112,8 @@ A big thank you to the following projects and their contributors. Without their
100112

101113
= 0.9.30 =
102114

103-
* **Marker Clustering**
104-
* Once enabled, Markers will be grouped together when they are close together. This can help to reduce clutter on the Map.
115+
* **<a href="https://www.waymark.dev/docs/marker-clustering/">Marker Clustering</a>**
116+
* Once enabled, Markers will be stacked when they are close together. This can help to reduce clutter on the Map.
105117
* You can enable this feature in Settings > Maps > Clustering, or using the `show_cluster="1"` Shortcode option.
106118
* There are also settings to adjust the cluster radius and what what zoom level to start clustering at.
107119
* Added `file_start_type` and `file_end_type` options to the <a href="https://www.waymark.dev/docs/shortcodes/#shortcode-files">Shortcode Files</a> feature, which allow you to automatically add a Marker of the specified type to the start and/or end of all Lines in the file. Thanks to <a href="https://wordpress.org/support/users/digbymaass/">digbymaass</a> for the <a href="https://wordpress.org/support/topic/shortcode-option-for-start-marker/">suggestion</a>.

0 commit comments

Comments
 (0)