feat(API): feed method

a cleaner, more concise way to add docs to the index
fergiemcdowall · Jun 24, 2017 · 7929477 · 7929477
1 parent 3dd796b
commit 7929477
Show file tree

Hide file tree

Showing 33 changed files with 1,048 additions and 291 deletions.
diff --git a/README.md b/README.md
@@ -10,9 +10,8 @@
 
 ```javascript
 const getData = function(err, myIndex) {
-  readStreamOfDocuments                   // <- a stream of documents to be indexed
-    .pipe(myIndex.defaultPipeline())      // <- an extentable document processing pipeline
-    .pipe(myIndex.add())                  // <- myIndex is a search index that can now be queried
+  readStreamOfDocuments        // <- a stream of documents to be indexed
+    .pipe(myIndex.feed())      // <- an extendable document processing pipeline (do objectMode: true for a stream of objects)
 }
 require('search-index')(options, getData) // <- make a new index
 ```