bump version to 0.9.0, cleanup readme

This commit is contained in:
Vinzenz Schroeter 2024-10-12 19:44:17 +02:00
parent 366aec054f
commit 9b618d4f35
6 changed files with 32 additions and 22 deletions

6
Cargo.lock generated
View file

@ -610,7 +610,7 @@ dependencies = [
[[package]] [[package]]
name = "servicepoint" name = "servicepoint"
version = "0.8.0" version = "0.9.0"
dependencies = [ dependencies = [
"bitvec", "bitvec",
"bzip2", "bzip2",
@ -626,7 +626,7 @@ dependencies = [
[[package]] [[package]]
name = "servicepoint_binding_c" name = "servicepoint_binding_c"
version = "0.8.0" version = "0.9.0"
dependencies = [ dependencies = [
"cbindgen", "cbindgen",
"servicepoint", "servicepoint",
@ -634,7 +634,7 @@ dependencies = [
[[package]] [[package]]
name = "servicepoint_binding_cs" name = "servicepoint_binding_cs"
version = "0.8.0" version = "0.9.0"
dependencies = [ dependencies = [
"csbindgen", "csbindgen",
"servicepoint", "servicepoint",

View file

@ -6,7 +6,7 @@ members = [
] ]
[workspace.package] [workspace.package]
version = "0.8.0" version = "0.9.0"
[workspace.lints.rust] [workspace.lints.rust]
missing-docs = "warn" missing-docs = "warn"

View file

@ -9,6 +9,17 @@ In [CCCB](https://berlin.ccc.de/), there is a big pixel matrix hanging on the wa
Display" or "Airport Display". Display" or "Airport Display".
This crate contains a library for parsing, encoding and sending packets to this display via UDP. This crate contains a library for parsing, encoding and sending packets to this display via UDP.
## Installation
```bash
cargo add servicepoint
```
or
```toml
[dependencies]
servicepoint = "0.9.0"
```
## Examples ## Examples
```rust ```rust
@ -32,22 +43,21 @@ This library is still in early development.
You can absolutely use it, and it works, but expect minor breaking changes with every version bump. You can absolutely use it, and it works, but expect minor breaking changes with every version bump.
Please specify the full version including patch in your Cargo.toml until 1.0 is released. Please specify the full version including patch in your Cargo.toml until 1.0 is released.
## Installation
```bash
cargo add servicepoint
```
## Features ## Features
This library has multiple compression libraries as optional dependencies. This library has multiple optional dependencies.
If you do not need compression/decompression support you can disable those features. You can choose to (not) include them by toggling the related features.
In the likely case you only need one of them, you can include that one specifically.
```toml | Name | Default | Description |
[dependencies] |--------------------|---------|--------------------------------------------|
servicepoint = { version = "0.8.0", default-features = false, features = ["compression-bz"] } | compression_zlib | false | Enable additional compression algo |
``` | compression_bzip2 | false | Enable additional compression algo |
| compression_lzma | true | Enable additional compression algo |
| compression_zstd | false | Enable additional compression algo |
| protocol_udp | true | Connection::Udp |
| protocol_websocket | false | Connection::WebSocket |
| rand | false | impl Distribution<Brightness> for Standard |
| cp437 | true | Conversion to and from CP-437 |
## Everything else ## Everything else

View file

@ -17,7 +17,7 @@ crate-type = ["staticlib", "cdylib", "rlib"]
cbindgen = "0.27.0" cbindgen = "0.27.0"
[dependencies.servicepoint] [dependencies.servicepoint]
version = "0.8.0" version = "0.9.0"
path = "../servicepoint" path = "../servicepoint"
features = ["all_compressions"] features = ["all_compressions"]

View file

@ -13,8 +13,8 @@ test = false
csbindgen = "1.9.3" csbindgen = "1.9.3"
[dependencies] [dependencies]
servicepoint_binding_c = { version = "0.8.0", path = "../servicepoint_binding_c" } servicepoint_binding_c = { version = "0.9.0", path = "../servicepoint_binding_c" }
servicepoint = { version = "0.8.0", path = "../servicepoint" } servicepoint = { version = "0.9.0", path = "../servicepoint" }
[lints] [lints]
workspace = true workspace = true

View file

@ -11,7 +11,7 @@
<PropertyGroup> <PropertyGroup>
<PackageId>ServicePoint</PackageId> <PackageId>ServicePoint</PackageId>
<Version>0.8.0</Version> <Version>0.9.0</Version>
<Authors>Repository Authors</Authors> <Authors>Repository Authors</Authors>
<Company>None</Company> <Company>None</Company>
<Product>ServicePoint</Product> <Product>ServicePoint</Product>