From 3bee35b0904c3a641a388bc0ce7cdf0ca7ea6f8b Mon Sep 17 00:00:00 2001
From: ducoterra <ducoterra@gmail.com>
Date: Sun, 5 Apr 2020 14:18:56 -0400
Subject: [PATCH] add a readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..876ab63
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Collector
+
+## Setup
+
+Create a "collector.json" with the following format:
+
+```json
+{
+    "graphite": {
+        "server": "graphite.ducoterra.net",
+        "port": 2003
+    },
+    "os": "osx", //osx or linux
+    "data": {
+        "storage": [
+            {
+                "path": "/Users/ducoterra",
+                "name": "home"
+            }, // as many paths as you want
+        ]
+    }
+}
+```
+
+Make collect.py executable:
+
+```bash
+chmod +x collect.py
+```
+
+Schedule a cronjob to run collect.py at your preferred interval
\ No newline at end of file