-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
7 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |