diff --git a/README.md b/README.md index 672a705..beb29c1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # pico-thermo -MicroPython app to read data from BME280 sensor and send it to Home Assistant \ No newline at end of file +MicroPython app to read data from BME280 sensor and send it to Home Assistant + +## Running + +Flash your Raspberry Pi Pico with MicroPython. + +Copy `config.example.py` to `config.py` and edit the settings to match your environment. + +Copy `main.py` and `config.py` to the root of the filesystem on the Pico. + +Connect the BME280 sensor to your Pico and power on. + +Head on to your Home Assistant instance and enjoy! + +## License + +This project is made available under the BSD 3-Clause license.