From a0a282759e7310ea95d68feb24afb2b3891d1074 Mon Sep 17 00:00:00 2001 From: Lauren Connors Date: Wed, 28 Dec 2022 04:11:05 -0600 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 5c3360c..ca4b081 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,18 @@ This is a program which allows you to type or pipe through stdin, into a [Mimic3 API](https://github.com/MycroftAI/mimic3) instance. I wrote it mostly for use with a [Linux TTS Plugin](https://github.com/Minizbot2012/LinuxTTSPlugin) as Mimic3 is a nice TTS software. + +## Usage + +``` +Usage: mimic3-keyboard [OPTIONS] + +Options: + --host [default: http://tts.local:59125] + -v, --voice [default: en_US/vctk_low#p236] + -s, --ssml + -r, --rate [default: 1.2] + -n, --noise [default: 0.33] + -h, --help Print help information + -V, --version Print version information +```