-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add getting started section to README
- Loading branch information
Showing
1 changed file
with
25 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,27 @@ | ||
# airthings-ble | ||
|
||
Library to control Airthings devices through BLE, primarily meant to be used in Home Assistant. | ||
Library to control Airthings devices through BLE, primarily meant to be used in | ||
the [Home Assistant integration](https://www.home-assistant.io/integrations/airthings_ble/). | ||
|
||
## Getting Started | ||
|
||
Prerequisites: | ||
|
||
- [Python 3.7.2+](https://www.python.org/downloads/) | ||
- [Poetry](https://python-poetry.org/docs/#installation) | ||
|
||
Install dependencies: | ||
|
||
```bash | ||
poetry install | ||
``` | ||
|
||
Run tests: | ||
|
||
```bash | ||
poetry run pytest | ||
``` | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |