Skip to content

Commit

Permalink
docs: add getting started section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
HormCodes committed Jan 5, 2024
1 parent 98becb8 commit deefa74
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
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.

0 comments on commit deefa74

Please sign in to comment.