vinzenz/servicepoint
0
0
Fork 0
mirror of https://github.com/cccb/servicepoint.git synced 2025-01-18 10:00:14 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

add badges

Browse source
This commit is contained in:
Vinzenz Schroeter 2024-05-12 01:49:38 +02:00
parent f98950725a
commit a6bae192dc
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,12 +1,16 @@
# servicepoint # servicepoint
[![crates.io](https://img.shields.io/crates/v/servicepoint2.svg)](https://crates.io/crates/servicepoint2) [![crates.io](https://img.shields.io/crates/v/servicepoint2.svg)](https://crates.io/crates/servicepoint2)
[![GPLv3 licensed](https://img.shields.io/badge/license-GPLv3-blue.svg)](./LICENSE) ![Crates.io Total Downloads](https://img.shields.io/crates/d/servicepoint2)
[![docs.rs](https://img.shields.io/docsrs/servicepoint2)](https://docs.rs/servicepoint2/latest/servicepoint2/)
[![GPLv3 licensed](https://img.shields.io/crates/l/servicepoint2)](./LICENSE)
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". 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. This repository contains a library for parsing, encoding and sending packets to this display via UDP.
### Installation ### Installation
```bash ```bash
# release version # release version
cargo add servicepoint2 cargo add servicepoint2
@ -22,18 +26,18 @@ fn main() {
// establish connection // establish connection
let connection = servicepoint2::Connection::open("172.23.42.29:2342") let connection = servicepoint2::Connection::open("172.23.42.29:2342")
.expect("connection failed"); .expect("connection failed");
// clear screen content // clear screen content
connection.send(servicepoint2::Command::Clear) connection.send(servicepoint2::Command::Clear)
.expect("send failed"); .expect("send failed");
} }
``` ```
More are available in the `examples` folder. More are available in the `examples` folder.
### Features ### Features
This library has multiple compression libraries as optional dependencies. This library has multiple compression libraries as optional dependencies.
If you do not need compression/decompression support you can disable those features. 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. In the likely case you only need one of them, you can include that one specifically.