1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..97ff495
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Static Single Sign On
+
+Http server for hosting static files behind single sign on:
+
+## Building 
+
+```bash
+make
+```
+
+## Installing
+
+It will generate a binary into the `./bin` folder. To install run:
+
+```bash
+sudo make install
+```
+
+You can also chose another location:
+
+```bash 
+PREFIX="$HOME/.local" make install
+```
+
+Or even using go cli:
+
+```bash
+go install git.sr.ht/~gabrielgio/s4o/cmd/s4o@latest
+```
+
+## Running
+
+To get all the param run `./s4o --help`, e.g.:
+
+```bash
+s4o \
+    --client-id="$CLIENT_ID" \
+    --client-secret="$CLIENT_SECRET" \
+    --issuer="$ISSUER" \
+    --callback="http://localhost:3000/callback"
+```