Add README

This commit is contained in:
Wesley Moore 2024-01-17 21:41:02 +10:00
parent a2fb1f345f
commit 5e53e48156
No known key found for this signature in database

17
README.md Normal file
View file

@ -0,0 +1,17 @@
esphome-proto
=============
[ESPHome native API][native-api] protocol data structures generated from
[protobuf files] in [the Python client][aioesphomeapi].
## Regenerating
In order to avoid each consumer of this crate having to regenerate the Rust
source and pull in build-time dependencies on the protobuf code generator the
generated files are committed into this repository.
To regenerate the files run `make codegen`.
[native-api]: https://esphome.io/components/api.html
[protobuf files]: https://github.com/esphome/esphome/blob/dev/esphome/components/api/api.proto
[aioesphomeapi]: https://github.com/esphome/aioesphomeapi