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
2 changed files
with
9 additions
and
39 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,42 +1,7 @@ | ||
# idx | ||
|
||
`idx` is a collection of composable indexes in javascript | ||
|
||
# installation | ||
|
||
1. install [npm] | ||
2. `npm install idx` | ||
|
||
# usage | ||
|
||
not yet | ||
|
||
# roadmap | ||
[![build status](https://secure.travis-ci.org/emitdb/idx.png)](http://travis-ci.org/emitdb/idx) | ||
[![deps status](https://david-dm.org/emitdb/idx.png)](https://david-dm.org/emitdb/idx) | ||
|
||
check [issues] | ||
|
||
# contribute | ||
|
||
everyone is welcome to contribute. patches, bug-fixes, new features | ||
|
||
1. create an [issue][issues] so the community can comment on your idea | ||
2. fork `idx` | ||
3. create a new branch `git checkout -b my_branch` | ||
4. create tests for the changes you made | ||
5. make sure you pass both existing and newly inserted tests | ||
6. commit your changes | ||
7. push to your branch `git push origin my_branch` | ||
8. create an pull request | ||
|
||
# meta | ||
|
||
* code: `git clone git://github.com/dscape/idx.git` | ||
* home: <http://github.com/dscape/idx> | ||
* bugs: <http://github.com/dscape/idx/issues> | ||
* build: [![build status](https://secure.travis-ci.org/dscape/idx.png)](http://travis-ci.org/dscape/idx) | ||
# idx | ||
|
||
`(oO)--',-` in [caos] | ||
`idx` is a collection of indexes in javascript on top of leveldb | ||
|
||
[npm]: http://npmjs.org | ||
[issues]: http://github.com/dscape/idx/issues | ||
[caos]: http://caos.di.uminho.pt/ |
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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
var assert = require('assert'); | ||
|
||
assert.ok(true); | ||
|
||
console.log('done'); |