commit 41e6f3892ca126cf5aa6647499c4b91587b79116
author Karthik Ramasamy <kramasamy@gmail.com> Thu Jun 08 14:23:48 2017 -0700
committer GitHub <noreply@github.com> Thu Jun 08 14:23:48 2017 -0700
tree b35ad9f417c005eaf7c52055b117375329e541e8
parent babd3f9b20408686d7c2303e413dddd735e63a24

add a readme file for pyheron (#1944)

* add a readme file for pyheron

* added the URL for streamparse

scripts/packages/BUILD

diff --git a/scripts/packages/BUILD b/scripts/packages/BUILD
index a8ce011..743bbad 100644
--- a/scripts/packages/BUILD
+++ b/scripts/packages/BUILD
@@ -322,6 +322,7 @@
     srcs = [
         "pyheron/requirements.txt", 
         "pyheron/setup.py.template",
+        "pyheron/README.txt",
     ] + generated_release_files,
     outs = generated_pyheron_egg_file,
     stamp = 1,

scripts/packages/pyheron/README.txt

diff --git a/scripts/packages/pyheron/README.txt b/scripts/packages/pyheron/README.txt
new file mode 100644
index 0000000..3fb0913
--- /dev/null
+++ b/scripts/packages/pyheron/README.txt
@@ -0,0 +1,3 @@
+PyHeron is the python API for Heron, the distributed streaming engine.
+The API is based on the streamparse Storm python API from Parsely. More
+details can be found at https://github.com/Parsely/streamparse