update docs

LouisChrist · Mar 16, 2024 · f437b5f · f437b5f
1 parent 402c741
commit f437b5f
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -6,6 +6,7 @@ Main Classes
 
 .. autoclass:: bluos.BluOSDevice
    :members:
+   :special-members: __init__
 
 Data Classes
 ------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,7 +1,20 @@
 BluOS Client
 ============
 
-This is a Python library for interfacing with BlueOS device.
+This is a Python library for interfacing with BlueOS device. It uses the 
+`BlueOS API <https://bluesound-deutschland.de/wp-content/uploads/2022/01/Custom-Integration-API-v1.0_March-2021.pdf>`_ 
+to control and query the status of BlueOS devices.
+
+A basic example of usage:
+
+.. code-block:: python
+
+   from blueos import BluOSDevice
+
+   async def main():
+      async with BluOSDevice("<host>") as device:
+         status = await device.status()
+         print(status)
 
 .. toctree::
    :maxdepth: 2

diff --git a/src/bluos/_device.py b/src/bluos/_device.py
@@ -23,7 +23,7 @@ class BluOSDevice:
     def __init__(self, host: str, port: int = 11000, session: aiohttp.ClientSession = None):
         """Represents a BluOS device.
 
-        The passed sessions will not be closed when the device is closed.
+        The passed sessions will not be closed when the device is closed and has to be closed by the caller.
 
         :param host: The hostname or IP address of the device.
         :param port: The port of the device. Default is 11000.