Upstream
/
aioesphomeapi
mirror of https://github.com/esphome/aioesphomeapi.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update readme (#633)

This commit is contained in:
J. Nick Koston 2023-11-11 14:08:08 -06:00 committed by GitHub
parent 0202e00eae
commit 2b219f79cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.rst
View File

@ -1,6 +1,15 @@
aioesphomeapi
=============
.. image:: https://github.com/esphome/aioesphomeapi/workflows/CI/badge.svg
:target: https://github.com/esphome/aioesphomeapi?query=workflow%3ACI+branch%3Amain
.. image:: https://img.shields.io/pypi/v/aioesphomeapi.svg
:target: https://pypi.python.org/pypi/aioesphomeapi
.. image:: https://codecov.io/gh/esphome/aioesphomeapi/branch/main/graph/badge.svg
:target: https://app.codecov.io/gh/esphome/aioesphomeapi/tree/main
``aioesphomeapi`` allows you to interact with devices flashed with `ESPHome <https://esphome.io/>`_.
Installation
@ -120,6 +129,12 @@ For development is recommended to use a Python virtual environment (``venv``).
# Update protobuf _pb2.py definitions (requires a protobuf compiler installation)
$ script/gen-protoc
A cli tool is also available for watching logs:
.. code:: bash
aioesphomeapi-logs --help
License
-------