Skip to content

Commit 6728f4f

Browse files
committed
Updated README
1 parent 8c31984 commit 6728f4f

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# python-ivona-api
22
[![Build status](https://img.shields.io/travis/Pythonity/python-ivona-api.svg)][travis]
3+
[![Test coverage](https://img.shields.io/coveralls/Pythonity/python-ivona-api.svg)][coveralls]
34
[![PyPI version](https://img.shields.io/pypi/v/ivona_api.svg)][pypi]
45
[![Python versions](https://img.shields.io/pypi/pyversions/ivona_api.svg)][pypi]
56
[![License](https://img.shields.io/github/license/Pythonity/python-ivona-api.svg)][license]
@@ -12,30 +13,35 @@ It currently only implements `CreateSpeech` and `ListVoices` endpoints,
1213
as they should cover the vast majority of use cases. Lexicons endpoints
1314
may be added in the future.
1415

15-
If you're looking for out-of-the-box solution, have a look at
16+
If you're looking for out-of-the-box solution, you should probably use
1617
[ivona-speak][ivona speak] - it's a script that uses this library and lets you
1718
use its functionality directly from your shell.
1819

1920
## Installation
2021
With PyPI:
22+
2123
```
2224
$ pip install ivona_api
2325
```
2426

2527
## API
26-
There's no documentation as of now, but the code is commented and
27-
*should* be pretty straightforward to use.
28+
There's no documentation as of now, but the code is commented and *should* be
29+
pretty straightforward to use.
2830

29-
But feel free to ask [me](mailto:[email protected]) if anything
31+
That said - feel free to ask [me](mailto:[email protected]) if anything
3032
is unclear.
3133

3234
## Tests
33-
Package was tested with the help of `py.test` and `tox` on Python 2.7, 3.4
34-
and 3.5 (see `tox.ini`).
35+
Package was tested with the help of `py.test` and `tox` on Python 2.7, 3.4, 3.5
36+
and 3.6 (see `tox.ini`).
3537

3638
To run tests yourself you need to set environment variables with secret
3739
and access keys before running `tox`:
40+
41+
Code coverage is available at [Coveralls][coveralls].
42+
3843
```shell
44+
$ pip install -r requirements/dev.txt
3945
$ export IVONA_ACCESS_KEY="YOUR_ACTUAL_ACCESS_KEY"
4046
$ export IVONA_SECRET_KEY="YOUR_ACTUAL_SECRET_KEY"
4147
$ tox
@@ -45,14 +51,15 @@ $ tox
4551
Package source code is available at [GitHub][github].
4652

4753
Feel free to use, ask, fork, star, report bugs, fix them, suggest enhancements,
48-
add functionality and point out any mistakes.
54+
add functionality and point out any mistakes. Thanks!
4955

5056
## Authors
5157
Developed and maintained by [Pythonity][pythonity].
5258

5359
Written by [Paweł Adamczak][pawelad].
5460

5561

62+
[coveralls]: https://coveralls.io/github/Pythonity/python-ivona-api
5663
[github]: https://github.com/Pythonity/python-ivona-api
5764
[ivona keys]: http://developer.ivona.com/en/speechcloud/introduction.html#Credentials
5865
[ivona speak]: https://github.com/Pythonity/ivona-speak

0 commit comments

Comments
 (0)