Merge pull request #12 from mozilla/issues/10

Fixes #10. Update README.

.env

@@ -0,0 +1 @@
+FLASK_APP=issue.py

Pipfile

@@ -9,6 +9,7 @@ name = "pypi"
 flask = "*"
 requests = "*"
 gunicorn = "*"
+python-dotenv = "*"
 
 [requires]
 python_version = "2.7"

Pipfile.lock

@@ -1,7 +1,7 @@
 {
     "_meta": {
         "hash": {
-            "sha256": "34199da70fb33d050c964c4b762c3e6a6ec9c7c27728588f184291c62ad9173e"
+            "sha256": "194d433e99a83bac8b9f2466fa6dde9905b300d039ec5eab5a1aa81b8353b587"
         },
         "pipfile-spec": 6,
         "requires": {
@@ -79,6 +79,14 @@
             ],
             "version": "==1.0"
         },
+        "python-dotenv": {
+            "hashes": [
+                "sha256:4965ed170bf51c347a89820e8050655e9c25db3837db6602e906b6d850fad85c",
+                "sha256:509736185257111613009974e666568a1b031b028b61b500ef1ab4ee780089d5"
+            ],
+            "index": "pypi",
+            "version": "==0.8.2"
+        },
         "requests": {
             "hashes": [
                 "sha256:6a1b267aa90cac58ac3a765d067950e7dbbf75b1da07e895d1f594193a40a38b",

README.md

@@ -4,7 +4,12 @@ Private repo used to host the code for filing issues from the webcompat-blipz-ex
 
 ## Local installation
 
-1. `pip install --user -r requirements.txt`
-2. `export FLASK_APP=issue.py`
-3. `flask run`
+We're using [pipenv](https://docs.pipenv.org/) for this project. Be sure to [install it first](https://docs.pipenv.org/#install-pipenv-today).
 
+0. clone the repo
+1. `pipenv sync --dev`
+2. `pipenv run flask run`
+
+Note: If you're trying to use this in production, it will expect a `OAUTH_TOKEN` environment variable, which contains a valid GitHub Oauth personal token.
+
+🚨 Please don't ever add it to the `.env` file and check it in. 🚨