Skip to content

Commit

Permalink
Change README to reStructuredText
Browse files Browse the repository at this point in the history
  • Loading branch information
koenvervloesem committed Jun 14, 2020
1 parent 3032c73 commit 0f8d258
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 89 deletions.
89 changes: 0 additions & 89 deletions README.md

This file was deleted.

67 changes: 67 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
##################
Rhasspy Hermes App
##################

.. image:: https://github.com/rhasspy/rhasspy-hermes-app/workflows/Tests/badge.svg
:target: https://github.com/rhasspy/rhasspy-hermes-app/actions
:alt: Continuous integration

.. image:: https://readthedocs.org/projects/rhasspy-hermes-app/badge/?version=latest
:target: https://rhasspy-hermes-app.readthedocs.io/en/latest/?badge=latest
:alt: Documentation status

..
.. image:: https://img.shields.io/pypi/v/rhasspy-hermes-app.svg
:target: https://pypi.org/project/rhasspy-hermes-app
:alt: PyPI package version
.. image:: https://img.shields.io/pypi/pyversions/rhasspy-hermes-app.svg
:target: https://www.python.org
:alt: Supported Python versions

.. image:: https://img.shields.io/github/license/rhasspy/rhasspy-hermes-app.svg
:target: https://github.com/rhasspy/rhasspy-hermes-app/blob/master/LICENSE
:alt: License

Rhasspy Hermes App is a helper library to create voice apps for Rhasspy_ (>=2.5) in Python using the `Hermes protocol`_

.. _Rhasspy: https://rhasspy.readthedocs.io/en/latest/

.. _`Hermes protocol`: https://docs.snips.ai/reference/hermes

************
Requirements
************

Rhasspy Hermes App requires:

* Python 3.7
* Rhasspy 2.5

************
Installation
************

A package can be installed from PyPI:

.. code-block::
pip3 install rhasspy-hermes-app
*************
Documentation
*************

Read the online documentation_ for more information about using the library, including the full API documentation with example code.

.. _documentation: https://rhasspy-hermes-app.readthedocs.io/en/latest/

*******
License
*******

This project is provided by `Koen Vervloesem`_ as open source software with the MIT license. See the LICENSE_ file for more information.

.. _`Koen Vervloesem`: mailto:[email protected]

.. _LICENSE: https://github.com/rhasspy/rhasspy-hermes-app/blob/master/LICENSE

0 comments on commit 0f8d258

Please sign in to comment.