Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(readme): remove head note #22

Merged
merged 15 commits into from
Oct 31, 2024
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@

A basic livebox exporter written in [rust](https://doc.rust-lang.org/book/title-page.html) 🦀. Start monitoring your livebox router's using [Prometheus](https://github.com/prometheus/prometheus) / [Grafana](https://github.com/grafana/grafana) 💪.

> ℹ️ **Note:** this minimal, draft, poc, "tool" **almost work with some luck** as it is now 🤞, but for "cool" educational purpose only. Some alternatives already **[exists](#alternative)** (check below), but didn't find any **rust** version yet. As I always wanted to learn **rust**, and I have a **livebox router** next to me, let's fill the gap (I think lol)! **Contributions/help/suggestions are really welcome!**


## Features

- **Should work** on livebox 4 and upper 🤷🏻‍
Expand Down Expand Up @@ -153,12 +150,12 @@ cd example && cp .env.example .env

*Update env..*

> Update your `LIVEBOX_PASSWORD` env secrets variable and source it

```sh
source .env
```

> Update your `LIVEBOX_PASSWORD` env secrets variable and source it

### Docker Compose
- Run the following command to start the services defined in the `docker-compose.yaml` file:
```sh
Expand Down
Loading