From 61167a14600555afbf2f8008eb1c25d4b805449d Mon Sep 17 00:00:00 2001 From: Kevin Briggs Date: Wed, 17 Jul 2013 11:07:46 -0400 Subject: [PATCH] Update README.md Fix to incorrect readme --- README.md | 41 ++++++++++++++++++++++------------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 798d0812c..3627a2321 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,28 @@ Colorful iconic & retina-proof markers for Leaflet, based on the Font Awesome/Tw JSfiddle demo ### Twitter Bootstrap/Font-Awesome icons -This plugin depends on Bootstrap or Font-Awesome for the rendering of the icons. The Font-Awesome fonts and CSS classes could be included in the project. See these urls for more information: +This plugin depends on either Bootstrap or Font-Awesome for the rendering of the icons. See these urls for more information: + +For Font-Awesome - http://fortawesome.github.com/Font-Awesome/ - http://fortawesome.github.com/Font-Awesome/#integration -Or if you are using bootstrap: +For Twitter bootstrap: - http://twitter.github.com/bootstrap/ ## Using the plugin -Copy the dist/images directory and css/js files to your project and include them: +- 1) First, follow the steps for including Font-Awesome or Twitter bootstrap into your application. + + For Font-Awesome, steps are located here: + + http://fortawesome.github.io/Font-Awesome/get-started/ + + For Twitter bootstrap, steps are here: + + http://twitter.github.io/bootstrap/getting-started.html + + +- 2) Next, copy the dist/images directory, awesome-markers.css, and awesome-markers.js to your project and include them: ````xml ```` @@ -23,7 +36,7 @@ Copy the dist/images directory and css/js files to your project and include them ```` -Now use the plugin to create a marker like this: +- 3) Now use the plugin to create a marker like this: ````js // Creates a red marker with the coffee icon var redMarker = L.AwesomeMarkers.icon({ @@ -31,10 +44,13 @@ var redMarker = L.AwesomeMarkers.icon({ color: 'red' }) -L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); + + L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); ```` -### Supported colors +### Supported colors: +**The following colors are supported** + The 'color' property currently supports these strings: - 'red' - 'darkred' @@ -70,19 +86,6 @@ var redMarker = L.AwesomeMarkers.icon({ L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); ```` -### Color of the icon -By default the icons are white, but you can set the color to black with the iconColor option. 'white' & 'black' are the only ones supported. -````js -// Creates a red marker with the coffee icon -var redMarker = L.AwesomeMarkers.icon({ - icon: 'flag', - color: 'red', - iconColor: 'black' -}) - -L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); -```` - ## 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