diff --git a/README.md b/README.md new file mode 100644 index 0000000..19ba682 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# servicepoint + +In [CCCB](https://berlin.ccc.de/), there is a big pixel matrix hanging on the wall. It is called "Service Point Display" or "Airport Display". +This repository contains a library for parsing, encoding and sending packets to this display via UDP. + +### Installation +```bash +cargo add --git https://github.com/kaesaecracker/servicepoint.git +``` + +### Example + +```rust +fn main() { + // establish connection + let connection = servicepoint2::Connection::open("172.23.42.29:2342") + .expect("connection failed"); + + // clear screen content + connection.send(servicepoint2::Command::Clear) + .expect("send failed"); +} +``` + +More are available in the `examples` folder. + +### Features + +This library has multiple compression libraries as optional dependencies. +If you do not need compression/decompression support you can disable those features. +In the likely case you only need one of them, you can include that one specifically. + +```toml +[dependencies.servicepoint2] +git = "https://github.com/kaesaecracker/servicepoint.git" +default-features = false +features = ["compression-bz"] +``` + +### Projects using the library + +- screen emulator: https://github.com/kaesaecracker/pixel-receiver-rs