Skip to content

Commit

Permalink
Update readme (#633)
Browse files Browse the repository at this point in the history
  • Loading branch information
bdraco authored Nov 11, 2023
1 parent 0202e00 commit 2b219f7
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
-------

Expand Down

0 comments on commit 2b219f7

Please sign in to comment.