update readme with additional context

This commit is contained in:
Tomasz Frątczak 2023-11-08 22:52:52 +01:00
parent 87159ed89a
commit 8ca102de26
1 changed files with 14 additions and 2 deletions

View File

@ -1,8 +1,20 @@
# bluewind # Bluewind
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
Bluetooth control app for Wahoo Headwind. Bluetooth control app for Wahoo Headwind.
## Usage
To run the flask app: To run the flask app:
```bash ```bash
export FLASK_ADDRESS='<headwind bluetooth address>'
flask --app api run --host=0.0.0.0 flask --app api run --host=0.0.0.0
``` ```
## Support
If you find this open source project useful consider leaving me a tip.
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/K3K8QVJRK)
If you would like to contribute, feel free to reach out, you can find my contact details at [https://blog.octopusx.de](https://blog.octopusx.de).