diff --git a/README.md b/README.md index 6dd008d..8eeb98b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # google-material-color -[Google material color](http://www.google.com/design/spec/style/color.html) implementation for Sass, Less, Stylus, CSS and JS. +[![NPM version](https://badge.fury.io/js/google-material-color.svg)](https://badge.fury.io/js/google-material-color) + +[Google material color](http://www.google.com/design/spec/style/color.html#color-color-palette) implementation for Sass, Less, Stylus, CSS and JS. > This color palette comprises primary and accent colors that can be used for illustration or to develop your brand colors. They’ve been designed to work harmoniously with each other. -[(http://www.google.com/design/spec/style/color.html)](http://www.google.com/design/spec/style/color.html). +([http://www.google.com/design/spec/style/color.html](http://www.google.com/design/spec/style/color.html#color-color-palette)). See the [demo](http://danlevan.github.io/google-material-color/test/) generated by the tests. @@ -15,9 +17,9 @@ See the [demo](http://danlevan.github.io/google-material-color/test/) generated * Sass (SCSS) 3.3+: [palette.scss](http://danlevan.github.io/google-material-color/dist/palette.scss) * CSS: [palette.css](http://danlevan.github.io/google-material-color/dist/palette.css) * JS: [palette.js](http://danlevan.github.io/google-material-color/dist/palette.js) supports (AMD, node, browser) -* NPM: `npm install google-material-color --save` -* Bower: `bower install google-material-color --save` -* Git: `git clone git://github.com/danlevan/google-material-color.git` +* NPM: `$ npm install google-material-color --save` +* Bower: `$ bower install google-material-color --save` +* Git: `$ git clone git://github.com/danlevan/google-material-color.git` ## Colors @@ -131,10 +133,36 @@ Search or open new issues [here][issues]. If you would like to suggest improvements or other libraries, you can also open an issue. +## Contributing + +### Fork + +Feel free to fork the project + + $ git clone git://github.com/danlevan/google-material-color.git + +### Running this + +Install [gulp](http://gulpjs.com/) + + $ npm install --global gulp + +Install the package + + $ npm install + +Run `gulp` to build the packages. The packages are in /dist/. + + $ gulp + +Run `gulp test` to build the test page. The test page can be found in /test/. + + $ gulp test + ## Release History See the [changelog](CHANGELOG.md) -## [License](LICENSE) +## License Licensed under [MIT](LICENSE).