update readme
This commit is contained in:
parent
52d9cc44b5
commit
1bff218ad1
1 changed files with 2 additions and 57 deletions
59
README.md
59
README.md
|
@ -1,19 +1,8 @@
|
|||
# gradient-parser
|
||||
[![Build Status][build-image]][build-url]
|
||||
[![Code GPA][gpa-image]][gpa-url]
|
||||
[![Test Coverage][coverage-image]][coverage-url]
|
||||
[![Dependency Status][depstat-image]][depstat-url]
|
||||
[![Bower Version][bower-image]][bower-url]
|
||||
[![NPM version][npm-image]][npm-url]
|
||||
[![IRC Channel][irc-image]][irc-url]
|
||||
[![Gitter][gitter-image]][gitter-url]
|
||||
[![GitTip][tip-image]][tip-url]
|
||||
|
||||
## About
|
||||
|
||||
All about how amazing the gradient-parser micro-library is.
|
||||
|
||||
This repository was scaffolded with [generator-microjs](https://github.com/daniellmb/generator-microjs).
|
||||
Parse CSS3 gradient definition and returns AST.
|
||||
|
||||
## Examples
|
||||
|
||||
|
@ -27,20 +16,11 @@ This repository was scaffolded with [generator-microjs](https://github.com/danie
|
|||
- `bower install gradient-parser`
|
||||
- [download the zip](https://github.com/rafaelcaricio/gradient-parser/archive/master.zip)
|
||||
|
||||
## Tasks
|
||||
|
||||
All tasks can be run by simply running `grunt` or with the `npm test` command, or individually:
|
||||
|
||||
* `grunt lint` will lint source code for syntax errors and anti-patterns.
|
||||
* `grunt gpa` will analyze source code against complexity thresholds.
|
||||
* `grunt test` will run the mocha unit tests against the source code.
|
||||
* `grunt test-min` will run the mocha unit tests against the minified code.
|
||||
|
||||
## License
|
||||
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2014 Rafael Carício rafael@caricio.com
|
||||
Copyright (c) 2014 Rafael Caricio rafael@caricio.com
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
|
@ -60,38 +40,3 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
|
||||
[build-url]: https://travis-ci.org/rafaelcaricio/gradient-parser
|
||||
[build-image]: http://img.shields.io/travis/rafaelcaricio/gradient-parser.png
|
||||
|
||||
[gpa-url]: https://codeclimate.com/github/rafaelcaricio/gradient-parser
|
||||
[gpa-image]: https://codeclimate.com/github/rafaelcaricio/gradient-parser.png
|
||||
|
||||
[coverage-url]: https://codeclimate.com/github/rafaelcaricio/gradient-parser/code?sort=covered_percent&sort_direction=desc
|
||||
[coverage-image]: https://codeclimate.com/github/rafaelcaricio/gradient-parser/coverage.png
|
||||
|
||||
[depstat-url]: https://david-dm.org/rafaelcaricio/gradient-parser
|
||||
[depstat-image]: https://david-dm.org/rafaelcaricio/gradient-parser.png?theme=shields.io
|
||||
|
||||
[issues-url]: https://github.com/rafaelcaricio/gradient-parser/issues
|
||||
[issues-image]: http://img.shields.io/github/issues/rafaelcaricio/gradient-parser.png
|
||||
|
||||
[bower-url]: http://bower.io/search/?q=gradient-parser
|
||||
[bower-image]: https://badge.fury.io/bo/gradient-parser.png
|
||||
|
||||
[downloads-url]: https://www.npmjs.org/package/gradient-parser
|
||||
[downloads-image]: http://img.shields.io/npm/dm/gradient-parser.png
|
||||
|
||||
[npm-url]: https://www.npmjs.org/package/gradient-parser
|
||||
[npm-image]: https://badge.fury.io/js/gradient-parser.png
|
||||
|
||||
[irc-url]: http://webchat.freenode.net/?channels=gradient-parser
|
||||
[irc-image]: http://img.shields.io/badge/irc-%23gradient-parser-brightgreen.png
|
||||
|
||||
[gitter-url]: https://gitter.im/rafaelcaricio/gradient-parser
|
||||
[gitter-image]: http://img.shields.io/badge/gitter-rafaelcaricio/gradient-parser-brightgreen.png
|
||||
|
||||
[tip-url]: https://www.gittip.com/rafaelcaricio
|
||||
[tip-image]: http://img.shields.io/gittip/rafaelcaricio.png
|
Loading…
Reference in a new issue