Skip to content

Commit

Permalink
Add headlines to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Espen Volden committed Oct 27, 2015
1 parent 89a30a3 commit 8718e45
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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
Expand Down

0 comments on commit 8718e45

Please sign in to comment.