Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
wssbck committed Feb 24, 2015
1 parent 5619223 commit 5df4d8c
Showing 1 changed file with 7 additions and 19 deletions.
26 changes: 7 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,17 @@
## Crossfilter Helpers
### Crossfilter Helpers

A set of reduction functions for [Crossfilter's reduce()](https://github.com/square/crossfilter/wiki/API-Reference#group_reduce). See the [wiki](https://github.com/wssbck/crossfilter-helpers/wiki) for details on how to use them.
A set of reduction functions for [Crossfilter's reduce()](https://github.com/square/crossfilter/wiki/API-Reference#group_reduce).

Install with npm:
[See the wiki](https://github.com/wssbck/crossfilter-helpers/wiki) for more details.

```javascript
npm install crossfilter-helpers
```
### Release notes

Build from source:
[Browse release notes](https://github.com/wssbck/crossfilter-helpers/releases) for updates.

```javascript
gulp build
```

Run tests with Jasmine:

```javascript
gulp test
```

## License
### License

Crossfilter Helpers is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

## Versioning and Development
### Versioning and Development

Crossfilter Helpers uses [Semantic Versioning](http://semver.org). The project is in early stage of development and changes quite rapidly - it is still not quite fit for production use. Please bear that in mind when you set it as a dependency, for example in your NPM package.

0 comments on commit 5df4d8c

Please sign in to comment.