New README

README.md

@@ -16,6 +16,29 @@ Amateur meteorological station in Swarzędz
 
 ![Baner](.github/img/baner.png)
 
-This is an amateur weather station mounted on a balcony. \
-The weather station runs on a Raspberry Pi Zero W microcomputer. \
-A DS18B20 sensor was used to measure temperature, and a BME280 sensor was used to measure humidity and pressure.
+## Hardware
+
+Amateur meteo station installed on the balcony. \
+The weather station works on a Raspberry Pi Zero W microcomputer. \
+A DS18B20 sensor was used to measure temperature, a BME280 sensor was used to measure humidity and pressure, and a PMS5003 sensor was used to measure air quality.
+
+## Available measurements
+
+- temperature
+- humidity
+- pressure
+- dew point (calculated from temperature and humidity)
+- PM 1.0
+- PM 2.5
+- PM 10
+- AQI (calculated from PM 10 and PM 2.5)
+
+## Available features
+
+- Current readings
+- Archive readings
+    - Table
+    - Chart
+    - Download - JSON, CSV, SQL, YAML, XML, Excel
+- API - current readings, archive readings
+- Widget - current readings

README_PL.md

@@ -15,6 +15,29 @@ Amatorska stacja meteo w Swarzędzu
 
 ![Baner](.github/img/baner.png)
 
-To jest amatorska stacja meteo zamontowana na balkonie. \
+## Sprzęt
+
+Amatorska stacja meteo zamontowana na balkonie. \
 Stacja meteo działa na mikrokomputerze Raspberry Pi Zero W. \
-Do pomiaru temperatury wykorzystany został czujnik DS18B20, a do pomiaru wilgotności i ciśnienia czujnik BME280.
+Do pomiaru temperatury wykorzystany został czujnik DS18B20, do pomiaru wilgotności i ciśnienia czujnik BME280, a do pomiaru jakości powietrza czujnik PMS5003.
+
+## Dostępne pomiary
+
+- temperatura
+- wilgotność
+- ciśnienie
+- punkt rosy (obliczany z temperatury i wilgotności)
+- PM 1.0
+- PM 2.5
+- PM 10
+- AQI (obliczany z PM 10 i PM 2.5)
+
+## Dostępne funkcje
+
+- Bieżące odczyty
+- Archiwalne odczyty
+    - Tabela
+    - Wykres
+    - Pobieranie - JSON, CSV, SQL, YAML, XML, Excel
+- API - bieżące odczyty, archiwalne odczyty
+- Widżet - bieżące odczyty