aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 4 insertions, 8 deletions
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.