From 9486963cc7d296cca57c7414579714440bfb2901 Mon Sep 17 00:00:00 2001
From: Ada <ada@noreply.localhost>
Date: Sat, 30 Sep 2023 15:45:29 +0000
Subject: [PATCH] add: readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..142359e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# A code share paste
+
+## Run
+Require redis and python, install python requirements with `pip install -r requirements.txt`. Run with `flask --app paste run` (add `--debug` for devlopement)
+You can configure with multiple environnement variables.
+- PASTE_REDIS_HOST: redis host (default localhost)
+- PASTE_REDIS_PORT: redis port (default 6379)
+- PASTE_REDIS_USER: redis username (default none)
+- PASTE_REDIS_PASSWORD: redis password (default none)
+- PASTE_URL_LENGTH: length for url used by paste
+- PASTE_SECRET_KEY: secret key for flask, don't use the default value (generate a safe value with `openssl rand -hex 16`).