From 3158a03cc105d788ed5ec231290d757c6e5f10ee Mon Sep 17 00:00:00 2001 From: Dominik Porada Date: Sun, 12 Jan 2014 21:17:30 +0100 Subject: [PATCH] Add installation and development instructions --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 99ff211..30bc2cf 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ > Angular.js filter for ordering collections by [semantic version number](http://semver.org). +## Installation + +```sh +bower install angular-semver-sort +``` + +If you’re building a Rails app, you can easily use it with [Rails Assets](https://rails-assets.org)—this package is available as `rails-assets-angular-semver-sort`. + ## Usage ### semverSort() @@ -20,6 +28,17 @@ ``` +## Development + +Clone the repository, then: + +```sh +npm install + +grunt +grunt test +``` + ## Credits The filter is **includes** the browser build of [node-semver](https://github.com/isaacs/node-semver), the BSD-licensed semver parser created by Isaac Z. Schlueter.