diff --git a/README.md b/README.md new file mode 100644 index 0000000..094a58e --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Bedside Clock + +Networked bedside clock utilising an ESP32-SOLO-1. + +## Planned Features + +- [ ] Audio alarms +- [ ] 7 segment display +- [ ] WiFi networking +- [ ] Console for configuration +- [ ] TCP API for configuration +- [ ] SNTP synchronisation + +## Firmware + +The firmware is a standard ESP-IDF v5.0 project; refer to [Espressif's +ESP-IDF +docs](https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32/index.html).