From cb4de46828d745162a8f0ed14fb10794b90c7875 Mon Sep 17 00:00:00 2001
From: Hagen Wierstorf <hwierstorf@audeering.com>
Date: Wed, 11 Dec 2024 12:19:22 +0100
Subject: [PATCH] DOC: add badges and links to README (#10)

---
 README.rst | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

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