Add some documentation + add a requirements file

1 files changed, 34 insertions, 0 deletions

diff --git a/app/README.md b/app/README.md
index a877cfa..21eb936 100644
--- a/app/README.md
+++ b/app/README.md
@@ -1,3 +1,37 @@
+## How to install `secretmgr`
+
+How to install its dependencies:
+
+```bash
+# on fedora:
+dnf install -y openldap-devel
+# on ubuntu:
+apt-get install -y libldap2-dev
+
+# for eveyrone:
+pip3 install --user --requirement requirements.txt
+```
+
+## How to use `secretmgr`
+
+Check that all secrets are correctly deployed for app `dummy`:
+
+```bash
+./secretmgr.py check dummy
+```
+
+Generate secrets for app `dummy` if they don't already exist:
+
+```bash
+./secretmgr.py gen dummy
+```
+
+Rotate secrets for app `dummy`, overwriting existing ones (be careful, this is dangerous!):
+
+```bash
+./secretmgr.py regen dummy
+```
+
 ## How to upgrade our packaged apps to a new version?
 
  1. Edit `docker-compose.yml`