From aa37e8e2919dde417db4e44050e4336ce2a82e3a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lauri=20V=C3=B5sandi?= <lauri@k-space.ee>
Date: Sat, 26 Aug 2023 21:20:37 +0300
Subject: [PATCH] Update README

---
 README.md | 35 ++++++++++++++++++++++++++++-------
 1 file changed, 28 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index ac14faf..14ecadc 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,35 @@
 # GoDoor
 
-[kdoorpi](https://git.k-space.ee/arti/kdoorpi) but in Go
+Go rewrite of [kdoorpi](https://git.k-space.ee/arti/kdoorpi). Uses
+[libgpiod](https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/about/)
+native Go library to access the general purpose pins in cross platform way.
 
-Uses Go native [libgpiod](https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/about/)
-library to access the gpio pins in cross platform way.
+# Developing
 
-# Cross compile
+Either build directly on Raspberry Pi or build locally and copy the binary
 
-    GOOS=linux GOARCH=arm64 go build
+```
+GOOS=linux GOARCH=arm64 go build
+scp godoor rpi4b:
+```
 
-# Test deploy
+# Deployment
 
-    scp godoor rpi4b:
+The CI system should automatically build docker image and push it to [Harbor](https://harbor.k-space.ee)
+
+Refer to
+[Ansible playbook](https://git.k-space.ee/k-space/kube/src/branch/master/ansible-doors.yml)
+on how to deploy on all door controllers
+
+# Usage
+
+For end users door can be opened by:
+
+* [Web interface](https://inventory.k-space.ee/m/doorboy)
+  * Push button
+  * Enrolling keyfob and swiping keyfob at door cardreader
+* Issuing `/open-...-door` command in #members channel
+
+For emergency cases:
+
+* Log into door controller via SSH and issue `killall -sUSR1 godoor`