Add README

This commit is contained in:
Andros Fenollosa 2018-04-05 09:27:43 +02:00
parent 3361d70e0a
commit f2cf97ce02

26
README.md Normal file
View File

@ -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
```