diff --git a/README.md b/README.md index 568f652..22c8a48 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ A writable stream for bulk indexing records in Elasticsearch # Usage +## Format + The records written to the stream has to have the following format: ```javascript { @@ -21,6 +23,8 @@ The records written to the stream has to have the following format: } ``` +## Buffering + The `highWaterMark` option set on the stream defines how many items will be buffered before doing a bulk indexing operation. The stream will also write all buffered items if its is closed, before emitting