From add553a2701b40191cd3234bc7bac7be2a12d0e3 Mon Sep 17 00:00:00 2001 From: Laurent Pelecq Date: Sun, 13 Mar 2022 15:16:47 +0100 Subject: [PATCH] Update readme * Direct link to documentation. * Todo list of features --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dd307d2..f962f5f 100644 --- a/README.md +++ b/README.md @@ -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 -------