From 8718e45735f0316b596616473cb2fe748fd14ac6 Mon Sep 17 00:00:00 2001 From: Espen Volden Date: Tue, 27 Oct 2015 20:56:44 +0100 Subject: [PATCH] Add headlines to README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) 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