From c752cf6a9c6280d74158ccdd31482fdbdecb6a81 Mon Sep 17 00:00:00 2001
From: chris <cg@zknt.org>
Date: Sun, 25 Oct 2020 17:57:50 +0100
Subject: [PATCH] basic readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dea52fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Budget Exporter
+
+Export Firefly-iii budget data for prometheus consumption.
+
+## Usage
+
+Install `Flask` and `requests` in your python environment:
+
+    pip install -r requirements.txt
+
+Create a personal access token in your firefly installation:
+
+Go to
+[https://your-firefly-installation/profile](https://your-firefly-installation/profile)
+, create a token and copy the (very long) string.
+
+Put your personal access token and your API host in your environment:
+
+    export FIREFLY_PERSONAL_ACCESS_TOKEN="abcd.....1234"
+    export FIREFLY_API_HOST="https://your-firefly-installation"
+
+Run the exporter:
+
+    FLASK_APP=exporter.py python -m flask run -h 127.0.0.1 -p 5000
+
+Now scrape `/metrics` on port localhost:5000.