Skip to content

Commit

Permalink
Improve README.md for public use of the package
Browse files Browse the repository at this point in the history
  • Loading branch information
mathieu-mp committed Jun 7, 2022
1 parent a5f97f7 commit 3f3209b
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ It uses direct TCP connection to the spa, and does not require access to the Int

It is written with asyncio network functions. It only supports asyncio usage.


## User installation

```bash
Expand All @@ -28,7 +27,7 @@ python3 -m pip install -U intex-spa

## Usage examples

Below are some examples, see `tests` directory for more examples
Below are some examples, see `examples` directory for more delight.

### Retrieve spa status
```python
Expand All @@ -54,7 +53,9 @@ asyncio.run(use_intex_spa())

## Changelog

This python package follows semantic versioning specification (SemVer).
This python package follows Semantic Versioning 2.0.0

***Reminder**: Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.*

### 0.1.2 - 2022-06-04

Expand Down

0 comments on commit 3f3209b

Please sign in to comment.