Skip to content

Commit 337f819

Browse files
committed
Upadating install and usage
1 parent 8a1d521 commit 337f819

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,35 @@ Try out the demo here: **[Demo Plnkr](http://embed.plnkr.co/MJC42K/preview)**
88

99

1010
## Install
11-
1. Download [tinycolor.js](https://github.com/bgrins/TinyColor)
12-
2. Add the package from NPM or Bower
13-
- npm:
14-
```
11+
#### NPM
12+
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.
13+
2. Install `md-color-picker`.
14+
```bash
1515
npm install md-color-picker
1616
```
1717

18-
- Bower:
19-
```
18+
#### Bower (includes tinycolor.js):
19+
```bash
2020
bower instal md-color-picker
2121
```
2222

23-
## Requiremnts
24-
The only requirement is [tinycolor.js](https://github.com/bgrins/TinyColor) which is an exceptional color manipulation library.
23+
## Usage
24+
1. Include the css.
25+
````html
26+
<link href="path/to/md-color-picker/dist/md-color-picker.min.css" rel="stylesheet" />
27+
````
28+
2. Include the javascript.
29+
````html
30+
<script src="path/to/tinycolor/dist/tinycolor.min.js"></script>
31+
<script src="path/to/md-color-picker/dist/md-color-picker.min.js"></script>
32+
````
33+
3. Place the directive where ever is needed.
34+
````html
35+
<div md-color-picker value="valueObj"></div>s
36+
````
37+
38+
## Dependencies
39+
The only dependency is [tinycolor.js](https://github.com/bgrins/TinyColor) which is an exceptional color manipulation library.
2540

2641
## Disclaimer
2742
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.

0 commit comments

Comments
 (0)