diff --git a/candid_client/README b/candid_client/README index c8c4242..5495f63 100644 --- a/candid_client/README +++ b/candid_client/README @@ -2,6 +2,8 @@ A library for handling connections to a [CANdid server](https://crates.io/crates/candid_server) over a TCP connection. +The CandidConnection struct can both read and write frames to the server, which are then written to the bus by candid_server. + Repository: https://gitlab.com/avandesa/candid-rs Documentation: https://docs.rs/crates/candid_client/ @@ -14,6 +16,11 @@ CANdid Client itself has no special dependencies, but for it to be useful, you m The example `echo` uses [`clap`](https://crates.io/crates/clap/) to handle command line arguments. +### Examples + +* `echo`: Print all frames to `stdout` +* `send`: Send 10 random frames, then start printing all frames to `stdout`. The sent frames should be displayed as well + ## Versioning We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://gitlab.com/avandesa/candid-rs/tags).