From f8e28b7a0c61b2847883805abdb314d44e71e71e Mon Sep 17 00:00:00 2001 From: lvoogdt Date: Fri, 15 Mar 2013 16:41:20 -0700 Subject: [PATCH 1/3] Initial commit --- README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000..2e3ef1bc1b --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +Leaflet.AwesomeMarkers +====================== + +Colorful iconic markers for Leaflet, based on the Font Awesome icons \ No newline at end of file From 065a24e57e46422708b42583477245b2207c4219 Mon Sep 17 00:00:00 2001 From: lvoogdt Date: Sat, 16 Mar 2013 00:41:35 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 56 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2e3ef1bc1b..2a2fb09ffa 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,57 @@ -Leaflet.AwesomeMarkers -====================== +# Leaflet.AwesomeMarkers plugin +Colorful iconic markers for Leaflet, based on the Font Awesome icons -Colorful iconic markers for Leaflet, based on the Font Awesome icons \ No newline at end of file +### Font-Awesome +This plugin depends on Font-Awesome for the rendering of the icons. The Font-Awesome fonts and CSS classes should be included in the project. See these urls for more information: +- http://fortawesome.github.com/Font-Awesome/ +- http://fortawesome.github.com/Font-Awesome/#integration + +## Using the plugin +Copy the dist/images directory and css/js files to your project and include them: +````xml + +```` +````xml + +```` + +Now use the plugin to create a marker like this: +````js +// Creates a red marker with the coffee icon +var redMarker = L.IconMarker.icon({ + icon: 'icon-coffee', + color: 'red' +}) + +L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); +```` + +### Supported colors +The 'color' property currently supports these strings: +- 'red' +- 'darkred' +- 'orange' +- 'green' +- 'darkgreen' +- 'blue' +- 'darkblue' +- 'purple' +- 'darkpurple' +- 'cadetblue' + +### Supported icons +The 'icon' property supports these strings: +- 'icon-coffee' +- 'icon-food' +- 'icon-plane' +- 'icon-star' +- 'icon-beer' +- .... and many more, see: http://fortawesome.github.com/Font-Awesome/#icons-new + +## License +- Leaflet.AwesomeMarkers and colored markers are licensed under the MIT License - http://opensource.org/licenses/mit-license.html. +- Font Awesome: http://fortawesome.github.com/Font-Awesome/#license + +## Contact +- Email: lvoogdt@gmail.com +- Website: http://lennardvoogdt.nl From e8381fdf1f0cdaa242570f253f5fe259bf2ac91e Mon Sep 17 00:00:00 2001 From: lvoogdt Date: Sat, 16 Mar 2013 00:47:55 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2a2fb09ffa..0ea8b22c41 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,16 @@ This plugin depends on Font-Awesome for the rendering of the icons. The Font-Awe ## Using the plugin Copy the dist/images directory and css/js files to your project and include them: ````xml - + ```` ````xml - + ```` Now use the plugin to create a marker like this: ````js // Creates a red marker with the coffee icon -var redMarker = L.IconMarker.icon({ +var redMarker = L.AwesomeMarkers.icon({ icon: 'icon-coffee', color: 'red' })