diff --git a/.gitignore b/.gitignore
index e231184..0439752 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@ styx-poc
 *.json
 *.txt
 styx
+config.yml
diff --git a/README.md b/README.md
index eb0a73a..aa34fb5 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,25 @@ go build
 ./styx
 ```
 
+### Example configuration:
+```
+// config.yml
+shodan:
+  key: REQUIRED
+
+// do not forget to set up kafka and create the topic
+kafka:
+  protocol: tcp
+  host: localhost
+  port: 9092
+  topic: styx
+  partition: 0
+
+balboa:
+  url: REQUIRED
+
+```
+
 ## Datastructure
 
 ### Meta