add doc

nicgirault · Dec 13, 2015 · 3b5991b · 3b5991b
1 parent 4218f9b
commit 3b5991b
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -5,11 +5,47 @@ An Angular stand-alone module to select a [color Brewer](http://colorbrewer2.org
 
 [Demo](http://plnkr.co/edit/aoDgRw3tu8VApuZ651tc?p=preview)
 
+## Install
+
+```shell
+bower install --save angular-colorBrewer-selector
 ```
-<palette-picker
-  initial-name='Blues'
-  initial-range='9'
-  initial-reverse='false'
-  on-select='onSelect(item, isReverse)'
-/>
+
+## Usage
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+
+    <script src="angular.min.js"></script>
+    <script src="angular-color-brewer-picker.min.js"></script>
+
+    <link rel="stylesheet" href="bootstrap.min.css">
+    <link rel="stylesheet" href="angular-color-brewer-picker.min.css">
+
+    <script>
+      angular.module('demo', ['colorBrewer'])
+      .controller('demoCtrl', function($scope) {
+        $scope.onSelect = function(item, isReverse){
+          console.log(item, isReverse);
+        };
+      });
+    </script>
+  </head>
+
+  <body ng-app="demo">
+    <div ng-controller="demoCtrl">
+      <div>
+        <palette-picker
+          initial-name='Blues'
+          initial-range='4'
+          initial-reverse='false'
+          on-select='onSelect(item, isReverse)'
+        />
+      </div>
+    </div>
+  </body>
+</html>
 ```
diff --git a/bower.json b/bower.json
@@ -1,9 +1,18 @@
 {
   "name": "angular-colorBrewer-selector",
-  "version": "0.0.3",
+  "description": "a stand alone angular directive to select a color brewer palette",
+  "version": "0.0.4",
   "homepage": "https://github.com/nicgirault/angular-colorBrewer-selector",
   "authors": [
-    "Nico <[email protected]>"
+    "nicgirault <[email protected]>"
+  ],
+  "keywords": [
+    "selector",
+    "color",
+    "picker",
+    "colorpicker",
+    "color brewer",
+    "angular"
   ],
   "license": "MIT",
   "ignore": [

diff --git a/package.json b/package.json
@@ -1,5 +1,19 @@
 {
   "name": "angular-colorBrewer-selector",
+  "description": "a stand alone angular directive to select a color brewer palette",
+  "version": "0.0.4",
+  "homepage": "https://github.com/nicgirault/angular-colorBrewer-selector",
+  "authors": [
+    "nicgirault <[email protected]>"
+  ],
+  "keywords": [
+    "selector",
+    "color",
+    "picker",
+    "colorpicker",
+    "color brewer",
+    "angular"
+  ],
   "dependencies": {
     "coffee-script": "^1.8.0",
     "del": "^1.1.1",
@@ -22,5 +36,10 @@
   },
   "devDependencies": {
     "gulp-minify-css": "^1.0.0"
-  }
+  },
+  "license": "MIT",
+  "main": [
+    "dist/angular-color-brewer-picker.min.css",
+    "dist/angular-color-brewer-picker.min.js"
+  ]
 }