diff --git a/README.md b/README.md index 3c1c0a7..4a8e67a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # ConnectedHumber-Air-Quality-Interface -> The web interface and JSON api for the ConnectedHumber Air Quality Monitoring Project. +> The web interface and JSON API for the ConnectedHumber Air Quality Monitoring Project. -This project contains the web interface for the ConnectedHumber air Quality Monitoring system. It is composed of 2 parts: +This project contains the web interface for the ConnectedHumber sensor system. Despite being called _Air Quality Web_, it is designed to display any kind of sensor data - not just air quality sensor readings. + + It is composed of 2 parts: - A PHP-based JSON API server (entry point: api.php) that's backed by a MariaDB server - A Javascript client application that runs in the browser diff --git a/docs/00-Welcome.md b/docs/00-Welcome.md index 5a7d5e9..6dd9a1c 100644 --- a/docs/00-Welcome.md +++ b/docs/00-Welcome.md @@ -4,4 +4,6 @@ This is the documentation for [Air Quality Web](https://github.com/ConnectedHumber/Air-Quality-Web/), the air quality web interface that displays data from sensors scattered about the globe. +Despite being called _Air Quality Web_, this project is in fact a generic interface to display sensor data. + Check out the sections in the sidebar for documentation on the installation process, configuring an installation, and the HTTP API provided.