From bebd4863e3a7ae970ca8377fa367ff4e6adfedb8 Mon Sep 17 00:00:00 2001 From: "carmenbourlonlong@gmail.com" Date: Mon, 26 Oct 2015 13:59:36 -0500 Subject: [PATCH] adding install instructions to readme --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 66d746ee6..c420fee49 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,17 @@ Adds support for drawing and editing vectors and markers on [Leaflet maps](https Leaflet.draw 0.2.0 changes a LOT of things from 0.1. Please see [BREAKING CHANGES](https://github.com/Leaflet/Leaflet.draw/blob/master/BREAKINGCHANGES.md) for how to upgrade. ## Table of Contents +[Install](#install) [Using the plugin](#using) [Advanced Options](#options) [Common tasks](#commontasks) [Thanks](#thanks) + +## Install + +To install the plugin run `npm install leaflet-draw` via command line in your project. You must also require this in your project like so: `var leaflet-draw = require('leaflet-draw');` + ## Using the plugin @@ -231,7 +237,7 @@ Polygon options include all of the Polyline options plus the option to show the | Option | Type | Default | Description | --- | --- | --- | --- -| shapeOptions | [Leaflet Path options](http://leafletjs.com/reference.html#path-options) | [See code](https://github.com/Leaflet/Leaflet.draw/blob/master/src/draw/handler/Draw.Circle.js#L7) | The options used when drawing the circle on the map. +| shapeOptions | [Leaflet Path options](http://leafletjs.com/reference.html#path-options) | [See code](https://github.com/Leaflet/Leaflet.draw/blob/master/src/draw/handler/Draw.Circle.js#L7) | The options used when drawing the circle on the map. | repeatMode | Bool | `false` | Determines if the draw tool remains enabled after drawing a shape. @@ -426,7 +432,7 @@ drawControl.setDrawingOptions({ ### Creating a custom build -If you only require certain handlers (and not the UI), you may wish to create a custom build. You can generate the relevant jake command using the [build html file](https://github.com/Leaflet/Leaflet.draw/blob/master/build/build.html). +If you only require certain handlers (and not the UI), you may wish to create a custom build. You can generate the relevant jake command using the [build html file](https://github.com/Leaflet/Leaflet.draw/blob/master/build/build.html). See [edit handlers example](https://github.com/Leaflet/Leaflet.draw/blob/master/examples/edithandlers.html) which uses only the edit handlers.