robinson/connectbox-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

move readme to the library crate

Browse Source
This commit is contained in:
lemonsh
2023-05-07 14:00:18 +02:00
parent 680b80c6dc
commit 5059ee63b0
1 changed files with 0 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
connectbox/README.md Normal file
View File

@@ -0,0 +1,16 @@
# connectbox-rs
API client library for the Compal CH7465LG, which is a cable modem provided by various European ISPs under the name Connect Box.
For more information, see the crate documentation.
### 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.