From 167f3ea624f5b57cc155446f2f97f866f720d4c3 Mon Sep 17 00:00:00 2001
From: jkerdreu <jkerdreu@b32b6428-25c9-4566-ad07-03861ab6144f>
Date: Tue, 16 Jul 2024 11:51:46 +0000
Subject: [PATCH] Added some docs
git-svn-id: https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7@3203 b32b6428-25c9-4566-ad07-03861ab6144f
---
devices/protocols/ESPHome/README.rst | 15 +++++++++++++--
devices/protocols/ESPHome/pyproject.toml | 12 ++++++++----
2 files changed, 21 insertions(+), 6 deletions(-)
diff --git a/devices/protocols/ESPHome/README.rst b/devices/protocols/ESPHome/README.rst
index b8ed145d..e7c44fb3 100644
--- a/devices/protocols/ESPHome/README.rst
+++ b/devices/protocols/ESPHome/README.rst
@@ -1,5 +1,16 @@
-xAAL ESPHome Gateway
-====================
+xaal.esphome
+============
+This package provides a simple way to integrate ESPHome devices with xAAL.
+
+
+Usage
+-----
+
+.. code:: shell
+
+ python -m xaal.esphome
+ # or
+ xaal-pkgrun esphome
- support Switch, Lamp and Contact right now
- more support still to come.
diff --git a/devices/protocols/ESPHome/pyproject.toml b/devices/protocols/ESPHome/pyproject.toml
index 839e3235..4c46f67d 100644
--- a/devices/protocols/ESPHome/pyproject.toml
+++ b/devices/protocols/ESPHome/pyproject.toml
@@ -3,10 +3,14 @@ name = "xaal.esphome"
version = "0.1"
description = "xAAL gateway for for ESPHome devices"
readme = "README.rst"
-authors = [ { name = "Jerome Kerdreux", email = "Jerome.Kerdreux@imt-atlantique.fr" } ]
-license = { text = "GPL License"}
-classifiers = ["Programming Language :: Python",
-"Topic :: Software Development :: Libraries :: Python Modules"]
+authors = [
+ { name = "Jerome Kerdreux", email = "Jerome.Kerdreux@imt-atlantique.fr" },
+]
+license = { text = "GPL License" }
+classifiers = [
+ "Programming Language :: Python",
+ "Topic :: Software Development :: Libraries :: Python Modules",
+]
keywords = ["xaal", "esphome"]
dependencies = ["xaal.lib", "aioesphomeapi"]
--
GitLab