From c6be837f72850ad73ac08f63b8a4569d14b60783 Mon Sep 17 00:00:00 2001
From: Peter Stockings <pstockings@jadeworld.com>
Date: Sat, 17 Sep 2022 13:38:41 +1000
Subject: [PATCH] Update readme

---
 readme.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index cf3d393..44e3560 100644
--- a/readme.md
+++ b/readme.md
@@ -1 +1,37 @@
-Workout Tracker for top sets
+# Workout tracker
+
+Track topsets over time.
+
+### Setup
+
+Install `python>3`
+
+Install dependencies
+
+```
+$ pip install -r requirements.txt
+```
+
+Enable development mode
+
+```
+PS $ENV:FLASK_ENV='development'
+```
+
+Set database url, either setup postgres database locally use migration script or expose deployed one
+
+```
+$Env:DATABASE_URL = 'postgres://postgres:***@***:***/***'
+```
+
+Start application:
+
+```
+flask run
+```
+
+### Features
+
+- [x] Track topsets for each workout
+- [x] Multi user
+- [ ] Authentication/Authorisation