Initial commit

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..03a1435
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+Leaflet Indoor
+=====================
+
+Provides basic tools to create indoor maps with
+[Leaflet](http://leafletjs.com).
+
+## Using the plugin
+
+See the included examples for usage.
+
+### Basic Usage
+
+Create a L.IndoorLayer, then add the data to it.
+
+```javascript
+var indoorLayer = new L.IndoorLayer();
+
+var levelControl = new L.Control.Level()
+
+// Connect the level control to the indoor layer
+levelControl.addEventListener("levelchange", indoorLayer.setLevel, indoorLayer);
+```
+
+## Events
+
+L.Control.Level will fire levelchange events when a level is selected.
+
+## License
+
+Leaflet Indoor is free software, and may be redistributed under the
+MIT-LICENSE.