Updating README with installation instructions

README.md

@@ -1,3 +1,28 @@
-# pico-weather
+# Pico Weather
 
-Raspberry Pi Pico app to read BME280 sensor data and send it to Home Assistant
+![Woodpecker CI badge](https://builds.metaunix.net/api/badges/92/status.svg)
+
+Raspberry Pi Pico app to read BME280 sensor data and send it to Home Assistant.
+
+Made in Go with [TinyGo](https://tinygo.org/).
+
+## Requirements
+
+* [TinyGo](https://tinygo.org/getting-started/install/) - TinyGo installation guide
+
+## Deployment
+
+1. Clone this git repository `git clone https://git.metaunix.net/gballan/pico-weather`.
+2. Copy `config.go.example` to `config.go` and modify the values to match your environment.
+3. Hold down the **BOOTSEL** button on your Raspberry Pi Pico 2W.
+4. Plug in your Pico to a USB port on your PC.
+5. Wait 2-3 seconds then release the **BOOTSEL** button.
+6. Flash the program to the Pico: `tinygo flash -target=pico2-w .`.
+  a. **Note**: On Pop!_OS I needed to open the file browser and mount the RP2350 partition manually while tinygo was attempting the flash, otherwise it would fail.
+7. Monitor the app: `tinygo monitor`.
+
+At this point, you should be able to deploy this. Unplug the Pico, connect your BME280 sensor and power it back on - you should start receiving data in Home Assistant under the name you set with `NodeName`.
+
+## License
+
+This project is made available under the BSD 3-Clause license.