refactor filenames and improve docs

1 files changed, 50 insertions, 8 deletions

diff --git a/README.md b/README.md
index f1bdbab..be7d7eb 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,53 @@
-### Flask-Pastebin
+<!--
+  -- Filename: README.md
+  -- Startdate: 2022-02-11
+  -->
+# Overview
+This is my proposed solution to my pastebin problem.
 
-This is a fork of [mitsuhiko/pastebin](https://github.com/mitsuhiko/flask-pastebin)
+# Features
 
-#### How to use
+* Admin page which can list parents, children, and provide link to delete pastes.
+* Editable titles
+* "Reply to" pastes to make parent/children relationships
+* UUIDs instead of sequential integer ID numbers
+* Private pastes (accessible to admin, and to users with the whole link)
 
-  1. make a virtualenv
-  2. `pip install -r requirements.txt`
-  3. `cp config.cfg.tpl config.cfg`
-  4. `python manage.py initdb`
-  5. `python manage.py server`
+# Instructions
+
+Configure the application with `config.cfg` based on `config.cfg.example`.
+
+Generate new db.
+
+    python3 initdb.py
+
+Run server in development mode.
+
+    FLASK_APP=stackbin.py FLASK_DEBUG=True flask run --host='0.0.0.0'
+
+Run the server in a full wsgi environment for the cleanup timer to operate.
+
+    ./stackbin.bin
+
+# Improvements
+I still need to work on these tasks:
+
+## Development
+
+* Protect the /admin/ page
+
+## Release
+
+* Document centos7 dependencies
+* Deploy to prod
+
+# Alternatives
+This is a very diverged fork of [su27/flask-pastebin](https://github.com/su27/flask-pastebin) which itself was a fork of the original [mitsuhiko/pastebin](https://github.com/mitsuhiko/flask-pastebin). The original had a few additional features worth reviewing.
+
+## Unresearched
+https://github.com/yasoob/logit-bin
+https://github.com/AWilliams17/PasteMate
+https://github.com/bsamadi/flask-pastebin
+
+## Attempted
+https://github.com/Tygs/0bin sounds cool but it uses a stack I'm unfamiliar with and it had some issues and I didn't want to bother with it.