From ea2dd4cccb9dd5124a7a4ca6a4229809721be715 Mon Sep 17 00:00:00 2001
From: Gavan Fantom <gavan@coolfactor.org>
Date: Thu, 23 Dec 2021 16:42:14 +0000
Subject: [PATCH] Add some installation instructions, and acknowledgement

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/README.md b/README.md
index 5724639..be0c5cf 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,37 @@
 # jlc-chart
 
 Flask app to chart component stock levels from JLCPCB
+
+# Installation
+
+This app can be deployed in the same way as any other WSGI application.
+
+With Apache, that looks something like this:
+
+    WSGIDaemonProcess jlc-chart user=... group=... threads=2
+    WSGIScriptAlias /jlc-chart /path/to/jlc-chart/wsgi.py
+    WSGIScriptReloading On
+
+    <Directory /path/to/jlc-chart>
+        WSGIProcessGroup jlc-chart
+        WSGIApplicationGroup %{GLOBAL}
+        AuthType Basic
+        AuthName "Restricted Content"
+        AuthUserFile /path/to/.htpasswd
+        Require valid-user
+    </Directory>
+
+Once configuration is complete, the database must be initialised:
+
+    flask init-db
+
+Once up and running, a cron job must be created to perform the poll:
+
+    crontab -e
+    1   9       *       *       *       /path/to/jlc-chart/poll
+
+# Acknowledgements
+
+With thanks to Unipart Digital for graciously allowing me to retain copyright
+of this project after it was initially developed as an in-house tool.
+