From fadafbdee9bec4f66f5883a85b3290de59ec5329 Mon Sep 17 00:00:00 2001
From: Alan Pryor <APryor@ATD-US.com>
Date: Sun, 19 May 2019 17:52:39 -0400
Subject: [PATCH] Update README

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index 558eb9d..6df50de 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,36 @@
 # flask_api_example
 
 A sample project showing how to build a scalable, maintainable, modular Flask API with a heavy emphasis on testing.
+
+## Running the app
+
+Preferably, first create a virtualenv and activate it, perhaps with the following command:
+
+```
+virtualenv -p python3 venv
+source venv/bin/activate
+```
+
+Next, run
+
+```
+pip install -r requirements.txt
+```
+
+to get the dependencies.
+
+Next, initialize the database
+
+```
+python manage.py seed_db
+```
+
+Type "Y" to accept the message (which is just there to prevent you accidentally deleting things -- it's just a local SQLite database)
+
+Finally run the app with
+
+```
+python wsgi.py
+```
+
+Navigate to the posted URL in your terminal to be greeted with Swagger, where you can test out the API.