From 6aed013796bb5e195100a82c9b93ac04a6bbc5da Mon Sep 17 00:00:00 2001
From: Oskar <o.winkels@fasttube.de>
Date: Sat, 5 Dec 2020 16:21:21 +0100
Subject: [PATCH] Improve and clean up README

---
 README.md | 39 ++++++++++++++++++---------------------
 1 file changed, 18 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 415e9e9..17bfbfb 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,10 @@
-# FT Corona Tracker
+# FaSTTUBe Corona Tracker
 
 Small webapp to track who was in which room at which time to backtrace
 potential viral infections.
 
-**WORK IN PROGRESS** This project is still under heavy construction and not
-ready for use in production.
-
-For Ideas and Progress see
-[Issues](https://git.fasttube.de/FaSTTUBe/ft-corona-tracker/issues).
+For Ideas, Progress, and Bugs visit
+[Issues](https://git.fasttube.de/FaSTTUBe/ftracker/issues).
 
 ## Requirements
 
@@ -17,7 +14,7 @@ For Ideas and Progress see
 
 ## How to run
 
-(Dev setup, prod setup not finished yet)
+(Dev setup, for prod deployment see below)
 
 ```bash
 # clone, cd into repo
@@ -27,11 +24,11 @@ python3 -m ftracker
 
 Edit `config.ini` to tune your installation.
 
-Then, point your browser at <http://localhost:5000/?arrival=42>.
+Then, point your browser at <http://localhost:5000/>.
 
 ## Installation/Deployment
 
-1. FTracker Backend
+### 1. FTracker Backend
 
 As above:
 ```bash
@@ -39,26 +36,26 @@ As above:
 pip install . # Use -e if you want to hack on the backend while installed.
 ```
 
-2. WSGI Server
+### 2. WSGI Server + Service file
 
 You need a WSGI Middleware (using `Flask`'s included `werkzeug` is discouraged
-for production environments.). I recommend `uwsgi` since it's flexible, fast
-and has `nginx` integration. A sample configuration file as well as service
-description files for both `systemd` and `rc` are included in `res/` which you
-can adapt to your system (file paths etc.) (The `systemd` service file still
-untested, feel free to leave feedback).
+for production environments). I recommend `uwsgi` since it's flexible, fast and
+has `nginx` integration. A sample configuration file as well as service
+description files for both `systemd` and `rc` are included in `res/` for you to
+adapt (file paths etc.) and install to your system (The `systemd` service file
+still untested though, feel free to leave feedback).
 
-3. Webserver
+### 3. Webserver
 
 You need a webserver. I recommend `nginx` because it's the industry standard
-and fast. A sample config file is included at `res/ftracker.nginx.conf` which
-you can adapt to your system (domain, SSL certs). The configuration should
-include: Webroot in `web/` with a fallback to the WSGI handler for the backend.
+and fast. A sample config file is included in `res/` for you to adapt (domain,
+SSL certs) and install to your system. The configuration should include:
+Webroot in `web/` with a fallback to the WSGI handler for the backend.
 
 Enabling SSL (https) and redirecting http to https is strongly encouraged, i
-recommend using `let'sencrypt`'s `certbot` to easily obtain certificates.
+recommend using `Let's Encrypt`'s `certbot` to easily obtain certificates.
 
-4. Customization
+### 4. Customization
 
 Edit `config.ini` to your liking. Restart the backend by restarting the `uwsgi`
 service, e.g. `sudo systemctl restart ftracker` or `sudo service ftracker