Update README to use pipenv

Addresses #3
okrahealth · May 13, 2019 · faefe32 · faefe32
1 parent f862773
commit faefe32
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,24 @@
 # Okra API
 
-RESTful API for okra. 
+RESTful API for okra.
+
+## Setup and Installation (for development)
+
+### Step 1: Configure pipenv
+
+-   Follow the instructions in the [pipenv README](https://github.com/pypa/pipenv/blob/master/README.md) to install pipenv on your system
+
+### Step 2: Install dependencies
+
+```shell
+pipenv install
+python setup.py install
+```
+
+### Step 3: Start pipenv shell
+
+```shell
+pipenv shell
+```
+
+This will spawn a new shell subprocess, which can be deactivated by using exit.