Github user HeartSaVioR commented on a diff in the pull request:
https://github.com/apache/storm/pull/573#discussion_r35388752
--- Diff: external/storm-elasticsearch/README.md ---
@@ -0,0 +1,66 @@
+# Storm Elasticsearch Bolt & Trident State
+
+ EsIndexBolt, EsPercolateBolt and EsState allows users to stream data
from storm into Elasticsearch directly.
+ For detailed description, please refer to the following.
+
+## EsIndexBolt (org.apache.storm.elasticsearch.bolt.EsIndexBolt)
+
+EsIndexBolt streams tuples directly into Elasticsearch. Tuples are indexed
in specified index & type combination.
+User should make sure that there are "source", "index","type", and "id"
fields declared in preceding bolts or spout.
+"index" and "type" fields are used for identifying target index and type.
+"source" is a document in JSON format string that will be indexed in
elastic search.
+
+```java
+EsConfig esConfig = new EsConfig();
+esConfig.setClusterName(clusterName);
+esConfig.setNodes(new String[]{"localhost:9300"});
+EsIndexBolt indexBolt = new IndexBolt(esConfig);
+```
+
+## EsPercolateBolt (org.apache.storm.elasticsearch.bolt.EsPercolateBolt)
+
+EsPercolateBolt streams tuples directly into Elasticsearch. Tuples are
used to send percolate request to specified index & type combination.
+User should make sure that there are "source", "index", and "type" fields
declared in preceding bolts or spout.
+"index" and "type" fields are used for identifying target index and type.
+"source" is a document in JSON format string that will be sent in
percolate request to elastic search.
+
+```java
+EsConfig esConfig = new EsConfig();
+esConfig.setClusterName(clusterName);
+esConfig.setNodes(new String[]{"localhost:9300"});
+EsPercolateBolt percolateBolt = new EsPercolateBolt(esConfig);
+```
+
+### EsConfig (org.apache.storm.elasticsearch.common.EsConfig)
+
+Two bolts above takes in EsConfig as a constructor arg.
+
+ ```java
+ EsConfig esConfig = new EsConfig();
+ esConfig.setClusterName(clusterName);
+ esConfig.setNodes(new String[]{"localhost:9300"});
+ ```
+
+EsConfig params
--- End diff --
```EsConfig params => ### EsConfig params```
It would be better to emphasize this section.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
