@asymmetrik/angular2-leaflet-filter - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

dist/bundles/angular2-leaflet-filter.js

@@ -1,2 +0,2 @@
-/*! @asymmetrik/angular2-leaflet-filter-0.0.1 - Copyright Asymmetrik, Ltd. 2007-2017 - All Rights Reserved.*/
+/*! @asymmetrik/angular2-leaflet-filter-0.0.2 - Copyright Asymmetrik, Ltd. 2007-2017 - All Rights Reserved.*/
 (function (global, factory) {
@@ -3,0 +3,0 @@ typeof exports === 'object' && typeof module !== 'undefined' ? factory() :

dist/bundles/angular2-leaflet-filter.min.js

@@ -1,2 +0,2 @@
-/*! @asymmetrik/angular2-leaflet-filter-0.0.1 - Copyright Asymmetrik, Ltd. 2007-2017 - All Rights Reserved.*/
+/*! @asymmetrik/angular2-leaflet-filter-0.0.2 - Copyright Asymmetrik, Ltd. 2007-2017 - All Rights Reserved.*/
 !function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t():"function"==typeof define&&define.amd?define(t):t()}(this,function(){"use strict";var e=require("./leaflet-filter/leaflet-filter.module");exports.LeafletFilterModule=e.LeafletFilterModule});

package.json

@@ -5,3 +5,3 @@ {
 	"description": "Angular 2 component for the Leaflet Filter plugin",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"author": "Asymmetrik, Ltd.",
@@ -26,3 +26,6 @@ "copyright": "Copyright Asymmetrik, Ltd. 2007-2017 - All Rights Reserved.",
 		"leaflet-draw": "0.4",
-		"@asymmetrik/leaflet-filter": "1.0"
+		"@asymmetrik/angular2-leaflet": "0.0",
+		"@asymmetrik/leaflet-filter": "1.0",
+
+		"font-awesome": "4"
 	},
@@ -29,0 +32,0 @@

README.md

@@ -18,8 +18,17 @@ # @asymmetrik/angular2-leaflet-filter
 ## Install 
-Install the package via npm:
+Install the package and its peer dependencies via npm:
 ```
+npm install font-awesome
+npm install leaflet
+npm install leaflet-draw
+npm install @asymmetrik/angular2-leaflet
 npm install @asymmetrik/angular2-leaflet-filter
 ```
 
+If you want to run the demo, clone the repository, perform an ```npm install```, ```gulp dev``` and then go to http://localhost:9000/src/demo/index.html
+
+
 ## Usage
+This component extends the [Angular 2 Leaflet component](https://github.com/Asymmetrik/angular2-leaflet) by adding directives for activating and configuring the [Filter plugin for Leaflet](https://github.com/Asymmetrik/leaflet-filter).
+
 Use the ```leaflet-filter``` attribute directive in conjunction with the ```leaflet``` attribute directive to activate a map and enable the filter control.
@@ -105,3 +114,6 @@
 
+### leafletFilterState
+Binds the current filter state. Can be one of a circle, rectangle, polygon, or null if there is no active filter.
 
+
 ## Contribute
@@ -114,3 +126,9 @@ PRs accepted. If you are part of Asymmetrik, please make contributions on feature branches off of the ```develop``` branch. If you are outside of Asymmetrik, please fork our repo to make contributions.
 
+## Credits
+**[Leaflet](http://leafletjs.com/)** Is an awesome mapping package.
+**[Leaflet Draw](https://github.com/Leaflet/Leaflet.draw)** Is an awesome extension to Leaflet that lets you draw shapes all over your maps.
+
+
+
 [travis-url]: https://travis-ci.org/Asymmetrik/angular2-leaflet-filter/
 [travis-image]: https://travis-ci.org/Asymmetrik/angular2-leaflet-filter.svg

No alert changes

Improved metrics

Total package byte prevSize

41074

increased by2.38%

Number of lines in readme file

132

increased by15.79%

Worsened metrics

Dependency count

7

increased by40%

No dependency changes