commit 94575d5cdb0036a6c6262641922500b24b5f83dd parent 3cac0f67738609e42ea089db547f6629c361225b Author: Chris Bracken <chris@bracken.jp> Date: Tue, 12 Apr 2022 17:33:35 -0700 Clean up README.md Improve formatting and add UI section with dashboard URL. Diffstat:
| M | README.md | | | 33 | +++++++++++++++++++++++---------- |
1 file changed, 23 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md @@ -1,16 +1,29 @@ Tempestas ========= -A small HTTP server backed by a PostgreSQL database for collecting data from -[sensor.community][sc] devices running the AirRohr firmware. - -API endpoints: -* /sensor/airrohr/: HTTP endpoint for submitting AirRohr formatted POST - requests. -* /sensor/reading/$sensorID/$readingType: HTTP endpoint for retrieving - JSON-formatted data for the specified sensor and reading type. -* /sensor/sensors/: HTTP endpoint for retrieving a JSON-formatted list of - sensors. +A small HTTP server backed by a PostgreSQL database for collecting and +displaying data from [sensor.community][sc] devices running the AirRohr +firmware. + + +UI +-- + +`/dashboard/`: HTTP GET endpoint for viewing charts of temperature, humidity, +pressure, and particulate matter across all sensors. + + +API Endpoints +------------- + +`/sensor/airrohr/`: HTTP endpoint for submitting AirRohr formatted POST +requests. + +`/sensor/reading/$sensorID/$readingType`: HTTP GET endpoint for retrieving +JSON-formatted data for the specified sensor and reading type. + +`/sensor/sensors/`: HTTP GET endpoint for retrieving a JSON-formatted list of +sensors. Building and running