README.md in jekyll-maps-1.1.1 vs README.md in jekyll-maps-1.1.2
- old
+ new
@@ -4,12 +4,15 @@
[](https://travis-ci.org/ayastreb/jekyll-maps)
[](https://codeclimate.com/github/ayastreb/jekyll-maps)
[](https://codeclimate.com/github/ayastreb/jekyll-maps/coverage)
[](https://gemnasium.com/github.com/ayastreb/jekyll-maps)
-Easily embed Google Maps with locations from your Jekyll posts, pages or data files.
+Jekyll Maps is a plugin that allows you to easily create different maps on your Jekyll site pages.
+It allows you to select which points to display on the map with different filters.
+GoogleMaps Marker Clusterer can be used if you have many points within close proximity.
+
## Installation
1. Add the following to your site's `Gemfile`:
```ruby
@@ -23,10 +26,12 @@
- jekyll-maps
```
## Usage
+### Data Source
+
First, add location information to your posts YAML front-matter:
```yml
location:
latitude: 51.5285582
@@ -58,19 +63,44 @@
You can configure map's dimensions and assign custom CSS class to the element:
```
{% google_map width:100% height:400 class:my-map %}
```
+
+### Filters
-You can also filter which locations to display on the map!
+You can also filter which locations to display on the map!<br/>
+For instance, following tag will only display locations from documents which have `lang: en` in their front-matter data.
-For instance, following tag will only display points from documents which have `lang: en` in their front-matter data.
-
```
{% google_map lang:en %}
```
+### Marker Cluster
+
+By default [Marker Clusterer](https://github.com/googlemaps/js-marker-clusterer) is enabled.
+If you have many markers on the map, it will group them and show icon with the count of markers in each cluster - [See example](https://googlemaps.github.io/js-marker-clusterer/examples/advanced_example.html)
+
+If you don't want to use marker cluster, you can disable it globally in `_config.yml`:
+
+ ```yml
+ maps:
+ google:
+ marker_cluster:
+ enabled: false
+ ```
+
+Or you can disable it per single map tag:
+
+ ```
+ {% google_map no_cluster %}
+ ```
+
If you have any questions or proposals - open up an [issue](https://github.com/ayastreb/jekyll-maps/issues/new)!
+
+## Examples
+
+Want to see it in action? Check out [Demo Page](https://ayastreb.github.io/jekyll-maps/#examples)!
## Contributing
1. Fork it (https://github.com/ayastreb/jekyll-maps/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)