Updated README

Pythonity · Jan 21, 2017 · e1adce7 · e1adce7
1 parent 1619bfa
commit e1adce7
Showing 1 changed file with 39 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # Ivona, Speak!
 [![Build status](https://img.shields.io/travis/Pythonity/ivona-speak.svg)][travis]
+[![Test coverage](https://img.shields.io/coveralls/Pythonity/ivona-speak.svg)][coveralls]
 [![PyPI version](https://img.shields.io/pypi/v/ivona_speak.svg)][pypi]
 [![Python versions](https://img.shields.io/pypi/pyversions/ivona_speak.svg)][pypi]
 [![License](https://img.shields.io/github/license/Pythonity/ivona-speak.svg)][license]
@@ -10,101 +11,88 @@ files, with help of Amazon's [IVONA][ivona]. All you need is a pair of
 to never speak again. If that's your thing of course.
 
 If you want to use IVONA Speech Cloud directly inside your Python project then
-have a look at [python-ivona-api][ivona api], which this script also uses.
+you should have a look at [python-ivona-api][ivona api], which this script in
+the background.
 
 ## Installation
 From PyPI (recommended):
+
 ```
 $ pip install ivona_speak
 ```
 
 With `git clone`:
+
 ```
 $ git clone https://github.com/Pythonity/ivona-speak
 $ pip install -r ivona-speak/requirements.txt
 $ cd ivona-speak/bin
 ```
 
 ## Usage
-The script comes with two subcommands (`synthesize` is the default one):
-```
-$ ivona-speak synthesize -h
-Usage: ivona-speak synthesize [OPTIONS] TEXT
 
-  Synthesize passed text and save it as an audio file
-
-Options:
-  --access-key TEXT          IVONA Speech Cloud access key.
-  --secret-key TEXT          IVONA Speech Cloud secret key.
-  -a, --auth-file FILENAME   Path to YAML file with 'access-key' and 'secret-
-                             key' set.
-  -o, --output-file PATH     Output audio file path.  [required]
-  -n, --voice-name TEXT      Voice name (default: Salli).
-  -l, --voice-language TEXT  Voice language (default: en-US).
-  -c, --codec [ogg|mp3|mp4]  Used codec (default: mp3).
-  -h, --help                 Show this message and exit.
 ```
+$ ivona-speak --help
 
-```
-$ ivona-speak list-voices -h
-Usage: ivona-speak list-voices [OPTIONS]
+  Easily convert passed text to synthesized audio files, with help of
+  Amazon's IVONA. All you need is a pair of auth keys.
 
-  List available Ivona voices
+  See https://github.com/Pythonity/ivona-speak for more info.
 
 Options:
-  --access-key TEXT          IVONA Speech Cloud access key.
-  --secret-key TEXT          IVONA Speech Cloud secret key.
-  -a, --auth-file FILENAME   Path to YAML file with 'access-key' and 'secret-
-                             key' set.
-  -l, --voice-language TEXT  Filter voice by language.
-  -h, --help                 Show this message and exit.
+  --help  Show this message and exit.
+
+Commands:
+  synthesize*  Synthesize passed text and save it as an...
+  list-voices  List available Ivona voices
+
 ```
 
 ## Examples
-With above usage everything should be pretty clear, but in case it isn't:  
+You can provide keys either explicitly: 
 
-You can provide keys either explicitly or put them in YAML file (one of those
-ways is required):
 ```
-$ ivona-speak list-voices --access-key 'YOUR_ACTUAL_ACCESS_KEY' --secret-key 'YOUR_ACTUAL_SECRET_KEY'
-$ ivona-speak list-voices -a secrets.yaml
+$ ivona-speak --access-key 'YOUR_ACTUAL_ACCESS_KEY' --secret-key 'YOUR_ACTUAL_SECRET_KEY' list-voices
 ```
 
-Also, `synthesize` is the default subcommand so those do the same:
+or export them as environment variables:
+
 ```
-$ ivona-speak synthesize -a secrets.yaml -o hello_world.mp3 'Hello world!'
-$ ivona-speak -a secrets.yaml -o hello_world.mp3 'Hello world!'
+$ export IVONA_ACCESS_KEY="YOUR_ACTUAL_ACCESS_KEY"
+$ export IVONA_SECRET_KEY="YOUR_ACTUAL_SECRET_KEY"
+$ ivona-speak list-voices
 ```
 
-List all available IVONA voices, and list them now:
+The default subcommand is `synthesize`, so these do the same:
+
 ```
-$ ivona-speak list-voices -a secrets.yaml
+$ ivona-speak synthesize -o hello_world.mp3 'Hello world!'
+$ ivona-speak -o hello_world.mp3 'Hello world!'
 ```
 
 I want someone to say 'Hello world!', and say it quick:
+
 ```
-$ ivona-speak synthesize -a secrets.yaml -o hello_world.mp3 'Hello world!'
+$ ivona-speak synthesize -o hello_world.mp3 'Hello world!'
 ```
 
 She sounds so nice. I want someone special to respond her:
-```
-$ ivona-speak synthesize -a secrets.yaml -o response.mp3 -n Joey 'How you doin?'
-```
 
-### Example auth file
 ```
-$ cat secrets.yaml
-access-key: YOUR_ACTUAL_ACCESS_KEY
-secret-key: YOUR_ACTUAL_SECRET_KEY
+$ ivona-speak synthesize -o response.mp3 -n Joey 'How you doin?'
 ```
 
 ## Tests
-Package was tested with the help of `py.test` and `tox` on Python 2.7, 3.4
-and 3.5 (see `tox.ini`).
+Package was tested with the help of `py.test` and `tox` on Python 2.7, 3.4, 3.5
+and 3.6 (see `tox.ini`).
+
+Code coverage is available at [Coveralls][coveralls].
 
 To run tests yourself you need to set environment variables with secret
-and access keys before running `tox`:
+and access keys before running `tox` inside the repository:
+
 ```shell
+$ pip install -r requirements/dev.txt
 $ export IVONA_ACCESS_KEY="YOUR_ACTUAL_ACCESS_KEY"
 $ export IVONA_SECRET_KEY="YOUR_ACTUAL_SECRET_KEY"
 $ tox
@@ -114,18 +102,19 @@ $ tox
 Package source code is available at [GitHub][github].
 
 Feel free to use, ask, fork, star, report bugs, fix them, suggest enhancements,
-add functionality and point out any mistakes.
+add functionality and point out any mistakes. Thanks!
 
 ## Authors
 Developed and maintained by [Pythonity][pythonity].
 
 Written by [Paweł Adamczak][pawelad].
 
 
+[coveralls]: https://coveralls.io/github/Pythonity/ivona-speak
 [github]: https://github.com/Pythonity/ivona-speak
+[ivona]: https://www.ivona.com/
 [ivona api]: https://github.com/Pythonity/python-ivona-api
 [ivona keys]: http://developer.ivona.com/en/speechcloud/introduction.html#Credentials
-[ivona]: https://www.ivona.com/
 [license]: https://github.com/Pythonity/ivona-speak/blob/master/LICENSE
 [pawelad]: https://github.com/pawelad
 [pypi]: https://pypi.python.org/pypi/ivona_speak