Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fergiemcdowall committed Sep 1, 2014
1 parent fddcce1 commit 2824545
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Expand Up @@ -104,7 +104,7 @@ Documents are then searchable with `si.search`.
#API


##si.add(batch, batchName, filters, callback(msg))
##si.add

Insets document into the index

Expand Down Expand Up @@ -142,7 +142,7 @@ remember to wrap home-rolled JSON with 'JSON.parse' to turn it into an
object.


##si.del(docID, callback(msg))
##si.del

Delete the document and all associated index entries.

Expand All @@ -152,7 +152,7 @@ si.del(docID, function(msg) {
});
```

##si.get(docID, callback(msg))
##si.get

Get the document and all associated index entries.

Expand All @@ -163,7 +163,7 @@ si.get(docID, function(msg) {
```


##si.search(query, callback(msg))
##si.search

Queries the search index

Expand Down Expand Up @@ -201,7 +201,7 @@ info):
```


##si.match(beginsWith, callback(suggestion))
##si.match

A matcher is a service that generates a dictionary of words based on
the contents of the index, and then returns appropriate sets based on
Expand All @@ -217,7 +217,7 @@ si.matcher(beginsWith, function(suggestion) {
```


##si.tellMeAboutMySearchIndex(callback(msg))
##si.tellMeAboutMySearchIndex

Returns metadata about the state of the index.

Expand All @@ -228,7 +228,7 @@ si.tellMeAboutMySearchIndex(function(msg) {
```


##si.empty(callback(msg))
##si.empty

Empties the search index, can be used in conjunction with replication.

Expand All @@ -239,7 +239,7 @@ si.empty(function(msg) {
```


##si.snapshot(callback(readStream))
##si.snapshot

Returns a `readStream` that can then be piped on, for instance to file.

Expand All @@ -254,7 +254,7 @@ si.snapShot(function(readStream) {
```


##si.replicate(readStream, callback(msg))
##si.replicate

Replicates an index from a snapshot file generated by `si.snapshot`.

Expand Down

0 comments on commit 2824545

Please sign in to comment.