Update readme.

main
Laurent Pelecq 2 years ago
parent de5ce128cb
commit 2ed0db35c0

@ -8,7 +8,10 @@ Rust SSIP Client
Speech Dispatcher [SSIP client library](http://htmlpreview.github.io/?https://github.com/brailcom/speechd/blob/master/doc/ssip.html) in pure rust. Speech Dispatcher [SSIP client library](http://htmlpreview.github.io/?https://github.com/brailcom/speechd/blob/master/doc/ssip.html) in pure rust.
The API is synchronous by default. An asynchronous API based on [Mio](https://github.com/tokio-rs/mio) is available with a feature. The API is synchronous by default.
A non-blocking API can be used with a low-level polling mechanism based on `poll`, or
with [mio](https://github.com/tokio-rs/mio).
- [x] Unix socket. - [x] Unix socket.
- [ ] TCP socket. - [ ] TCP socket.
@ -21,17 +24,17 @@ The API is synchronous by default. An asynchronous API based on [Mio](https://gi
Getting Started Getting Started
--------------- ---------------
To use the synchronous API, use: To use the synchronous API or an asynchronous API compatible with low-level crates based on `poll`, use:
```toml ```toml
[dependencies] [dependencies]
ssip-client = "0.4" ssip-client = "0.6"
``` ```
For the asynchronous API, use: For the asynchronous API, use:
```toml ```toml
[dependencies] [dependencies]
ssip-client = { version = "0.4", features = ["async-mio"] } ssip-client = { version = "0.6", features = ["async-mio"] }
``` ```
Example Example

Loading…
Cancel
Save