From 40095d578cf3eb04e9fb9c27e9455886ee706624 Mon Sep 17 00:00:00 2001 From: Laurent Pelecq Date: Sat, 12 Mar 2022 19:19:04 +0100 Subject: [PATCH] Fix readme for first release --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c97fbd..2279637 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,24 @@ Rust SSIP Client ================ -[![build status](https://gitlab.com/lp-accessibility/ssip-client/badges/master/pipeline.svg)](https://gitlab.com/lp-accessibility/ssip-client/commits/master) -[![license](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue)](https://gitlab.com/lp-accessibility/ssip-client/raw/master/COPYING) +[![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) 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. + +Example +------- + +```rust +use ssip_client::{new_default_fifo_client, ClientName}; +let mut client = new_default_fifo_client(&ClientName::new("joe", "hello"), None)?; +let msg_id = client.say_line("hello")?; +client.quit()?; +``` + License -------