Update readme

* Direct link to documentation.
* Todo list of features
main
Laurent Pelecq 2 years ago
parent 64f37c1e9c
commit add553a270

@ -4,12 +4,15 @@ Rust SSIP Client
[![build status](https://gitlab.com/lp-accessibility/ssip-client/badges/main/pipeline.svg)](https://gitlab.com/lp-accessibility/ssip-client/commits/main)
[![license](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue)](https://gitlab.com/lp-accessibility/ssip-client/raw/main/LICENSE-MIT)
[![Crates.io Version](https://img.shields.io/crates/v/ssip-client.svg)](https://crates.io/crates/ssip-client)
[![docs.rs](https://docs.rs/ssip-client/badge.svg)](https://docs.rs/crate/ssip-client/)
[![docs.rs](https://docs.rs/ssip-client/badge.svg)](https://docs.rs/ssip-client/latest/ssip_client/)
Speech Dispatcher [SSIP client library](http://htmlpreview.github.io/?https://github.com/brailcom/speechd/blob/master/doc/ssip.html) in pure rust.
* Support notifications.
* Message history is not yet supported.
- [x] Stop, cancel, pause and resume.
- [x] List, set voices.
- [x] Set rate, pitch, volume.
- [x] Notifications.
- [ ] Message history.
Example
-------
@ -21,6 +24,8 @@ let msg_id = client.say_line("hello")?;
client.quit()?;
```
See [other examples](https://gitlab.com/lp-accessibility/ssip-client/-/tree/main/examples) in the repository.
License
-------

Loading…
Cancel
Save