From 2cfa671338ee8149fa78436a1df7356cf22c4684 Mon Sep 17 00:00:00 2001
From: boyska <boyska@riseup.net>
Date: Fri, 20 May 2022 18:33:22 +0200
Subject: [PATCH] readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9cab65a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# tResetter
+
+tResetter is a simple program that allows people to change their password.
+
+## Why
+
+From a sysadmin perspective, it's main advantage is that it's not bound to a specific data model: you will
+write the glue to actually verify/change the password.
+
+From a user perspective, it's main advantage is that it will *not* let the user choose passwords: it will
+generate and propose password to the user.
+
+## Howto
+
+```
+apt install python3-fastapi python3-pydantic python3-redis
+env VALIDATE_LOGIN_EXE=/bin/echo CHANGE_PASSWORD_EXE=/bin/echo uvicorn  tresetter:app
+```
+