1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc51738
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# How to run
+
+Small sample project using faust to read from kafka
+
+```
+# Bring project up
+make up
+# In terminal 1, generator fake data
+make enter
+python data_generator.py
+# In terminal 2, read from topic
+make enter
+faust -A hello_world worker -l info
+```