add basic readme and license

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-Present Wez Furlong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,26 @@
+# Govee to MQTT bridge for Home Assistant
+
+This repo provides a `govee` executable whose primary purpose is to act
+as a bridge between [Govee](https://govee.com) lights and Home Assistant,
+via the [Home Assistant MQTT Integration](https://www.home-assistant.io/integrations/mqtt/).
+
+## Features
+
+* Robust LAN-first design. Not all of Govee's devices support LAN control,
+  but for those that do, you'll have the lowest latency and ability to
+  control them even when your primary internet connection is offline.
+* Support for per-device modes and scenes.
+* Support for the undocumented AWS IoT interface to your devices, provides
+  low latency status updates.
+* Support for the new [Platform
+  API](https://developer.govee.com/reference/get-you-devices) in case the AWS
+  IoT or LAN control is unavailable.
+
+## Credits
+
+This work is based on my earlier work with [Govee LAN
+Control](https://github.com/wez/govee-lan-hass/).
+
+The AWS IoT support was made possible by the work of @bwp91 in
+[homebridge-govee](https://github.com/bwp91/homebridge-govee/).
+