diff options
author | Galen Guyer <galen@galenguyer.com> | 2020-11-08 21:01:46 -0500 |
---|---|---|
committer | Galen Guyer <galen@galenguyer.com> | 2020-11-08 21:01:46 -0500 |
commit | 0082af242cf9453b1cf6ba31083d3148c54e28f2 (patch) | |
tree | a3be22fb8d3da7b8990e0bf306d5e9cd610eab02 /README.md | |
parent | 78c070c079c13a67c96099e63a590b6467ceb197 (diff) |
update README with endpoint descriptions
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 12 |
1 files changed, 4 insertions, 8 deletions
@@ -1,12 +1,8 @@ -# Flask wsgi bootstrap/demo - -This demo shows the use of gunicorn with flask. Original credit goes to [Max Meinhold](https://github.com/mxmeinhold/flask-gunicorn-demo). -It includes a basic Dockerfile, a linting demonstration using Pylint, and a Travis CI configuration for running linting. - -This is not an in depth guide in how these tools work, but a basic starting point and reference. - -Make sure to change my name and email if you use this template, especially in the license. +# RIT COVID Poller +## Endpoints +- `/api/v0/latest` - retrieve the current state of the dashboard in JSON format +- `/api/v0/history` - retrieve all the prior states of the dashboard ## Setup Locally running this application should be pretty simple. |