From 0082af242cf9453b1cf6ba31083d3148c54e28f2 Mon Sep 17 00:00:00 2001 From: Galen Guyer Date: Sun, 8 Nov 2020 21:01:46 -0500 Subject: update README with endpoint descriptions --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 445bf35..15a2a42 100644 --- a/README.md +++ b/README.md @@ -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. -- cgit v1.2.3