diff --git a/README.md b/README.md index c3c017b..f8a12c3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ 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-shell`](connectbox-shell) - Interactive shell for managing a Connect Box modem powered by the connectbox-rs crate. \ No newline at end of file +* [`connectbox-shell`](connectbox-shell) - Interactive shell for managing a Connect Box modem, powered by the connectbox-rs crate. \ No newline at end of file diff --git a/connectbox-shell/README.md b/connectbox-shell/README.md new file mode 100644 index 0000000..89b1955 --- /dev/null +++ b/connectbox-shell/README.md @@ -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 +``` diff --git a/connectbox/README.md b/connectbox/README.md index da147d0..af17bc0 100644 --- a/connectbox/README.md +++ b/connectbox/README.md @@ -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. +## Supported endpoints +- [x] Devices list +- [x] Port forwarding +- [ ] Wireless settings + +This list will grow as the project progresses. + ### 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. Contributions adding IPv6 support are always welcome, though. -### Credits -Special thanks to the authors of the following projects: - * [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) - -They have saved me from hours of reverse engineering work. +### Similar projects +* [home-assistant-ecosystem/python-connect-box](https://github.com/home-assistant-ecosystem/python-connect-box) (Python) +* [ties/compal_CH7465LG_py](https://github.com/ties/compal_CH7465LG_py) (Python)