Add readme

algocry · Jan 21, 2024 · 1188417 · 1188417
1 parent 6e5c908
commit 1188417
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+# AQI Predictor
+
+AQI (Air Quality Index) predictor web app for forecasting AQI at your location in the given time interval using machine learning.
+
+## Features
+
+* Live forecast rendering
+* Uses Prophet time series prediction model with Flask API
+* Multiple prediction parameters like PM2.5, PM10, NO2, NH3, SO2, CO, OZONE
+* Custom date, training interval and training time can be chosen
+* Responsive UI
+
+## Previews
+
+### Preview 1 (Large screen)
+![preview-1](./previews/preview1.png)
+
+### Preview 2 (Small screen)
+![preview-2](./previews/preview2.png)
+
+
+## Future developments
+
+Too occupied to work it on but always open to check issues, contribution pull requests and feedbacks
diff --git a/previews/preview1.png b/previews/preview1.png
diff --git a/previews/preview2.png b/previews/preview2.png