bump version to 0.9.0, cleanup readme
This commit is contained in:
		
							parent
							
								
									366aec054f
								
							
						
					
					
						commit
						9b618d4f35
					
				
					 6 changed files with 32 additions and 22 deletions
				
			
		
							
								
								
									
										6
									
								
								Cargo.lock
									
										
									
										generated
									
									
									
								
							
							
						
						
									
										6
									
								
								Cargo.lock
									
										
									
										generated
									
									
									
								
							|  | @ -610,7 +610,7 @@ dependencies = [ | |||
| 
 | ||||
| [[package]] | ||||
| name = "servicepoint" | ||||
| version = "0.8.0" | ||||
| version = "0.9.0" | ||||
| dependencies = [ | ||||
|  "bitvec", | ||||
|  "bzip2", | ||||
|  | @ -626,7 +626,7 @@ dependencies = [ | |||
| 
 | ||||
| [[package]] | ||||
| name = "servicepoint_binding_c" | ||||
| version = "0.8.0" | ||||
| version = "0.9.0" | ||||
| dependencies = [ | ||||
|  "cbindgen", | ||||
|  "servicepoint", | ||||
|  | @ -634,7 +634,7 @@ dependencies = [ | |||
| 
 | ||||
| [[package]] | ||||
| name = "servicepoint_binding_cs" | ||||
| version = "0.8.0" | ||||
| version = "0.9.0" | ||||
| dependencies = [ | ||||
|  "csbindgen", | ||||
|  "servicepoint", | ||||
|  |  | |||
|  | @ -6,7 +6,7 @@ members = [ | |||
| ] | ||||
| 
 | ||||
| [workspace.package] | ||||
| version = "0.8.0" | ||||
| version = "0.9.0" | ||||
| 
 | ||||
| [workspace.lints.rust] | ||||
| missing-docs = "warn" | ||||
|  |  | |||
|  | @ -9,6 +9,17 @@ In [CCCB](https://berlin.ccc.de/), there is a big pixel matrix hanging on the wa | |||
| Display" or "Airport Display". | ||||
| 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 | ||||
| 
 | ||||
| ```rust | ||||
|  | @ -23,7 +34,7 @@ fn main() { | |||
| } | ||||
| ``` | ||||
| 
 | ||||
| More examples are available in the crate.  | ||||
| More examples are available in the crate. | ||||
| Execute `cargo run --example` for a list of available examples and `cargo run --example <name>` to run one. | ||||
| 
 | ||||
| ## Note on stability | ||||
|  | @ -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. | ||||
| Please specify the full version including patch in your Cargo.toml until 1.0 is released. | ||||
| 
 | ||||
| ## Installation | ||||
| 
 | ||||
| ```bash | ||||
| cargo add servicepoint | ||||
| ``` | ||||
| 
 | ||||
| ## 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. | ||||
| This library has multiple optional dependencies. | ||||
| You can choose to (not) include them by toggling the related features. | ||||
| 
 | ||||
| ```toml | ||||
| [dependencies] | ||||
| servicepoint = { version = "0.8.0", default-features = false, features = ["compression-bz"] } | ||||
| ``` | ||||
| | Name               | Default | Description                                | | ||||
| |--------------------|---------|--------------------------------------------| | ||||
| | 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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -17,7 +17,7 @@ crate-type = ["staticlib", "cdylib", "rlib"] | |||
| cbindgen = "0.27.0" | ||||
| 
 | ||||
| [dependencies.servicepoint] | ||||
| version = "0.8.0" | ||||
| version = "0.9.0" | ||||
| path = "../servicepoint" | ||||
| features = ["all_compressions"] | ||||
| 
 | ||||
|  |  | |||
|  | @ -13,8 +13,8 @@ test = false | |||
| csbindgen = "1.9.3" | ||||
| 
 | ||||
| [dependencies] | ||||
| servicepoint_binding_c = { version = "0.8.0", path = "../servicepoint_binding_c" } | ||||
| servicepoint = { version = "0.8.0", path = "../servicepoint" } | ||||
| servicepoint_binding_c = { version = "0.9.0", path = "../servicepoint_binding_c" } | ||||
| servicepoint = { version = "0.9.0", path = "../servicepoint" } | ||||
| 
 | ||||
| [lints] | ||||
| workspace = true | ||||
|  |  | |||
|  | @ -11,7 +11,7 @@ | |||
| 
 | ||||
|     <PropertyGroup> | ||||
|         <PackageId>ServicePoint</PackageId> | ||||
|         <Version>0.8.0</Version> | ||||
|         <Version>0.9.0</Version> | ||||
|         <Authors>Repository Authors</Authors> | ||||
|         <Company>None</Company> | ||||
|         <Product>ServicePoint</Product> | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Vinzenz Schroeter
						Vinzenz Schroeter