diff --git a/README.rst b/README.rst index 277fafe..27a023c 100644 --- a/README.rst +++ b/README.rst @@ -2,4 +2,29 @@ audmodel ======== -Library to publish and load machine learning models. +|tests| |coverage| |docs| |python-versions| |license| + +**audmodel** publishes and loads machine learning models. + +Have a look at the installation_ and usage_ instructions. + +.. _installation: https://audeering.github.io/audmodel/installation.html +.. _usage: https://audeering.github.io/audmodel/usage.html + + +.. badges images and links: +.. |tests| image:: https://github.com/audeering/audmodel/workflows/Test/badge.svg + :target: https://github.com/audeering/audmodel/actions?query=workflow%3ATest + :alt: Test status +.. |coverage| image:: https://codecov.io/gh/audeering/audmodel/branch/main/graph/badge.svg?token=drrULW8vEG + :target: https://codecov.io/gh/audeering/audmodel/ + :alt: Code coverage +.. |docs| image:: https://img.shields.io/pypi/v/audmodel?label=docs + :target: https://audeering.github.io/audmodel/ + :alt: Documentation +.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg + :target: https://github.com/audeering/audmodel/blob/main/LICENSE + :alt: MIT license +.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audmodel.svg + :target: https://pypi.org/project/audmodel/ + :alt: Supported Python versions