From 87e89bf75725baf7b90a0d7dfe0af3d8a2f72312 Mon Sep 17 00:00:00 2001
From: Jean-Louis Huynen <gallypette@users.noreply.github.com>
Date: Wed, 5 Jun 2019 11:48:28 +0200
Subject: [PATCH] Create README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..460042e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# analyzer-d4-balboa
+Ingests Type 8 Passive DNS and writes into a linux socket for balboa https://github.com/DCSO/balboa to consume
+
+# Installation
+```bash
+go get https://github.com/D4-project/analyzer-d4-balboa
+```
+
+# Configuration files
+ - balboa_socket: path to the UNIX socket
+ - redis: path to the d4 redis server
+ - redis_queue: uuid of the analyzer's redis queue
+ 
+ # Use
+ ```bash
+ $analyzer-d4-balboa -c conf.sample
+ ```
+ 
+ # Query Balboa to test
+ Once you launched the analyzer, pick one of the domains listed in its output and query Balboa (serving here on http://127.0.0.1:8080):
+ ```bash
+ #!/bin/bash
+curl \
+ -X POST \
+ -H 'Content-Type: application/json' \
+ --data '{"query" : "query{ entries(rrname: \"www.cnn.com\", limit: 1) { rrname rrtype rdata time_first time_last sensor_id count } } "}' http://127.0.0.1:8080/
+ ```