organize the readmes better

This commit is contained in:
lemonsh 2023-05-20 14:33:34 +02:00
parent 9494e1b9e0
commit e238369ae5
3 changed files with 19 additions and 7 deletions

View File

@ -1,3 +1,3 @@
Projects in this repository: Projects in this repository:
* [`connectbox-rs`](connectbox) - API client crate for the Compal CH7465LG, which is a cable modem provided by various European ISPs under the name Connect Box. * [`connectbox-rs`](connectbox) - API client crate for the Compal CH7465LG, which is a cable modem provided by various European ISPs under the name Connect Box.
* [`connectbox-shell`](connectbox-shell) - Interactive shell for managing a Connect Box modem powered by the connectbox-rs crate. * [`connectbox-shell`](connectbox-shell) - Interactive shell for managing a Connect Box modem, powered by the connectbox-rs crate.

View File

@ -0,0 +1,8 @@
# connectbox-shell
Interactive shell for managing a Connect Box modem.
## Installation
You can install this project easily using this command:
```sh
cargo install --git https://git.lemonsh.moe/lemon/connectbox-rs.git
```

View File

@ -3,14 +3,18 @@ API client library for the Compal CH7465LG, which is a cable modem provided by v
For more information, see the crate documentation. For more information, see the crate documentation.
## Supported endpoints
- [x] Devices list
- [x] Port forwarding
- [ ] Wireless settings
This list will grow as the project progresses.
### IPv6 Notice ### IPv6 Notice
I am running my modem in the IPv4 mode, so the options available to me are different than what IPv6 mode users see. Thus, this crate will likely not work correctly with IPv6 mode Connect Boxes. I am running my modem in the IPv4 mode, so the options available to me are different than what IPv6 mode users see. Thus, this crate will likely not work correctly with IPv6 mode Connect Boxes.
Contributions adding IPv6 support are always welcome, though. Contributions adding IPv6 support are always welcome, though.
### Credits ### Similar projects
Special thanks to the authors of the following projects: * [home-assistant-ecosystem/python-connect-box](https://github.com/home-assistant-ecosystem/python-connect-box) (Python)
* [home-assistant-ecosystem/python-connect-box](https://github.com/home-assistant-ecosystem/python-connect-box) * [ties/compal_CH7465LG_py](https://github.com/ties/compal_CH7465LG_py) (Python)
* [ties/compal_CH7465LG_py](https://github.com/ties/compal_CH7465LG_py)
They have saved me from hours of reverse engineering work.