Skip to content

Commit 0fc8399

Browse files
committed
Update documentation: refine installation instructions and enhance project description
1 parent 6602304 commit 0fc8399

File tree

3 files changed

+18
-16
lines changed

3 files changed

+18
-16
lines changed

docs/getting-started.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,17 @@
77

88
## Install pyOverkiz from PyPi
99

10+
11+
### With UV <small>recommended</small> { #with-uv data-toc-label="with uv" }
12+
1013
```bash
11-
pip install pyoverkiz
14+
uv add pyoverkiz
1215
```
1316

14-
If you use uv:
17+
### With pip
1518

1619
```bash
17-
uv add pyoverkiz
20+
pip install pyoverkiz
1821
```
1922

2023
## Choose your server

docs/index.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,32 @@
22
hide:
33
- navigation
44
- toc
5+
- title
56
---
67
# pyOverkiz
78

8-
pyOverkiz is an async Python client for the OverKiz platform, used by vendors like Somfy and Atlantic. It lets you authenticate, discover devices, read states, execute commands, and consume gateway events.
9+
pyOverkiz is an async Python library for interacting with Overkiz-based platforms, including Somfy and Atlantic. It enables authentication, device discovery, state reading, command execution, and real-time event streaming from supported gateways.
910

1011
## What you can do
1112

12-
- Connect to cloud or local gateways
13-
- Discover devices and read states
14-
- Send commands to your devices
15-
- Consume event streams for near real-time updates
13+
- Authenticate with Overkiz cloud or local gateways
14+
- Automatically discover and list connected devices
15+
- Read device states and attributes
16+
- Execute commands on devices
17+
- Receive real-time updates via event streams
1618

1719
## Supported hubs
1820

1921
- Atlantic Cozytouch
2022
- Bouygues Flexom
21-
<!-- - Brandt Smart Control **\*** -->
2223
- Hitachi Hi Kumo
2324
- Nexity Eugénie
24-
<!-- - Rexel Energeasy Connect **\*** -->
2525
- Sauter Cozytouch
2626
- Simu (LiveIn2)
2727
- Somfy Connexoon IO
2828
- Somfy Connexoon RTS
2929
- Somfy TaHoma
3030
- Somfy TaHoma Switch
3131
- Thermor Cozytouch
32-
33-
## Where to go next
34-
35-
- Start with the [Getting started](getting-started.md) guide
36-
- Learn the architecture in [Core concepts](core-concepts.md)
37-
- Browse the [API reference](api-reference.md)
32+
<!-- - Brandt Smart Control **\*** -->
33+
<!-- - Rexel Energeasy Connect **\*** -->

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ repo_url: https://github.com/iMicknl/python-overkiz-api
33
edit_uri: edit/main/docs/
44

55
docs_dir: docs
6+
copyright: This project is not affiliated with Overkiz, Somfy, or any other mentioned brand. All trademarks and brand names are the property of their respective owners.
67

78
extra:
89
generator: false
@@ -14,6 +15,7 @@ theme:
1415
- toc.follow
1516
- search.suggest
1617
- search.highlight
18+
- navigation.footer
1719

1820
plugins:
1921
- search
@@ -32,6 +34,7 @@ markdown_extensions:
3234
- pymdownx.highlight
3335
- pymdownx.superfences
3436
- pymdownx.tasklist
37+
- admonition
3538

3639
nav:
3740
- Overview: index.md

0 commit comments

Comments
 (0)