instructions in README

CityOfLosAngeles · Oct 4, 2018 · ed02e14 · ed02e14
1 parent 83f227f
commit ed02e14
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,16 @@
 # mds-validator
 A package to automatically validate MDS APIs for compliance and testing purposes. 
+
+To validate an API, you'll need an active Bearer token. 
+
+For example, to validate the lime API, you can run `python validator.py --provider-name lime --token [YOUR TOKEN HERE] --postfix /los_angeles`. 
+
+## Developing / installing
+
+mds-validator uses pipenv. To install packages and run the script: 
+
+1. `pipenv install`
+
+2. `pipenv shell`
+
+3. `python validator.py --your-commands-here`