From 337f8199858ff6bde5c7290edd9945c04dca90b5 Mon Sep 17 00:00:00 2001 From: Brian Kelley Date: Sat, 5 Sep 2015 02:42:53 -0500 Subject: [PATCH] Upadating install and usage --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f595b2f..5d844b4 100644 --- a/README.md +++ b/README.md @@ -8,20 +8,35 @@ Try out the demo here: **[Demo Plnkr](http://embed.plnkr.co/MJC42K/preview)** ## Install -1. Download [tinycolor.js](https://github.com/bgrins/TinyColor) -2. Add the package from NPM or Bower - - npm: -``` +#### NPM +1. Download [tinycolor.js](https://github.com/bgrins/TinyColor) 1.2.1 or higher. Other versions may work, though 1.2.1 was used to develop this. +2. Install `md-color-picker`. +```bash npm install md-color-picker ``` - - Bower: -``` +#### Bower (includes tinycolor.js): +```bash bower instal md-color-picker ``` -## Requiremnts -The only requirement is [tinycolor.js](https://github.com/bgrins/TinyColor) which is an exceptional color manipulation library. +## Usage +1. Include the css. +````html + +```` +2. Include the javascript. +````html + + +```` +3. Place the directive where ever is needed. +````html +
s +```` + +## Dependencies +The only dependency is [tinycolor.js](https://github.com/bgrins/TinyColor) which is an exceptional color manipulation library. ## Disclaimer This is still in a very early beta, and is rappidly changing (3 versions before initial commit). I am open to any and all help anyone is willing to put in. Will update as we go.