Skip to content

Commit

Permalink
DOC: add badges to README (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw authored Jan 25, 2024
1 parent 30ea4d5 commit 85caf73
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
auglib
======

|tests| |coverage| |docs| |python-versions| |license|

**auglib** is an augmentation library,
which provides transforms_
to modify audio signals_ and files_.
Expand Down Expand Up @@ -32,3 +34,21 @@ and listen to examples_.
.. _transforms: https://audeering.github.io/api/auglib.transform.html
.. _usage: https://audeering.github.io/usage.html
.. _user defined: https://audeering.github.io/api/auglib.transform.Function.html


.. badges images and links:
.. |tests| image:: https://github.com/audeering/auglib/workflows/Test/badge.svg
:target: https://github.com/audeering/auglib/actions?query=workflow%3ATest
:alt: Test status
.. |coverage| image:: https://codecov.io/gh/audeering/auglib/branch/main/graph/badge.svg?token=3J0sF7GQhA
:target: https://codecov.io/gh/audeering/auglib/
:alt: code coverage
.. |docs| image:: https://img.shields.io/pypi/v/auglib?label=docs
:target: https://audeering.github.io/auglib/
:alt: auglib's documentation
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
:target: https://github.com/audeering/auglib/blob/main/LICENSE
:alt: auglib's MIT license
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/auglib.svg
:target: https://pypi.org/project/auglib/
:alt: auglib's supported Python versions

0 comments on commit 85caf73

Please sign in to comment.