Add README

2018-04-05 09:27:43 +02:00 · 2018-04-05 09:27:43 +02:00 · f2cf97ce02
commit f2cf97ce02
parent 3361d70e0a
1 changed files with 26 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,26 @@
+# API POSTAL CODE WALLAVISO
+
+## URL
+
+https://hidden-sierra-35586.herokuapp.com
+
+## REQUESTS
+
+### Get for index
+https://hidden-sierra-35586.herokuapp.com/api/v1/index/{integer}
+
+### Get for postal code
+https://hidden-sierra-35586.herokuapp.com/api/v1/postal_code/{integer}
+
+## INSTALL
+
+```bash
+pipenv install
+pipenv shell
+```
+
+## RUN
+
+```bash
+python3 app.py
+```