1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fd712bc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# influxdb guard
+
+Simple *firewall* for influxdb database
+
+## Running
+
+Requires [pyinflux](https://github.com/yvesf/pyinflux) library.
+
+### development
+
+```
+# ./run.py
+... prints default config
+# ./run.py <path-to-config>
+```
+
+### gunicorn/waitress
+
+```
+# waitress-serve run:application
+# gunicorn3 run
+```
+Searches for a file called `config` in current working directory.
+\ No newline at end of file