diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e491c3 --- /dev/null +++ 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 +```