Skip to content

Commit

Permalink
api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tj committed Jul 28, 2011
1 parent 2bbb218 commit e7ef61a
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,23 @@ Search results for "tobi dollars":
- Tobi wants four dollars
```

## API

```js
reds.add(text, id[, fn]);
reds.remove(id[, fn]);
reds.search(text, fn[, type]);
```

Examples:

```js
reds.add('Foo bar baz', 'abc');
reds.add('Foo bar', 'bcd');
reds.remove('bcd');
reds.search('foo bar', function(err, ids){});
```

## About

Currently reds strips stop words and applies the metaphone algorithm to the remaining words before mapping the constants in Redis sets. For example the following text:
Expand Down

0 comments on commit e7ef61a

Please sign in to comment.