Skip to content

Commit

Permalink
Update index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewReid854 committed Apr 3, 2021
1 parent caf2857 commit 0bdd43e
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

-------------------------------------

|pypi| |docs| |build and test| |codecov| |code quality| |downloads| |license|

*check4updates* is a Python library for developers that prompts your users to upgrade when a new version of your package is released.

Contents:
============
=========

.. toctree::
:maxdepth: 1
Expand All @@ -22,4 +24,39 @@ Contents:

Changelog
Pull requests and suggested enhancements
Contributing
Contributing

.. |pypi| image:: https://img.shields.io/pypi/v/check4updates?color=brightgreen&logo=Python&logoColor=white&label=PyPI%20package
:alt: PyPI package
:scale: 100%
:target: https://pypi.org/project/check4updates/

.. |docs| image:: https://img.shields.io/readthedocs/check4updates/latest.svg?logo=read%20the%20docs&logoColor=white&label=Docs&version=latest
:alt: docs
:scale: 100%
:target: https://check4updates.readthedocs.io/en/latest/

.. |build and test| image:: https://github.com/MatthewReid854/check4updates/actions/workflows/build_and_test.yml/badge.svg
:alt: Build and Test
:scale: 100%
:target: https://github.com/MatthewReid854/check4updates/actions/workflows/build_and_test.yml

.. |code quality| image:: https://img.shields.io/lgtm/grade/python/g/MatthewReid854/check4updates.svg?logo=lgtm&logoWidth=18
:alt: code quality: python
:scale: 100%
:target: https://lgtm.com/projects/g/MatthewReid854/check4updates/context:python

.. |codecov| image:: https://codecov.io/github/MatthewReid854/check4updates/badge.svg?branch=main&service=github
:alt: lines of code
:scale: 100%
:target: https://codecov.io/github/MatthewReid854/check4updates?branch=main

.. |downloads| image:: https://static.pepy.tech/personalized-badge/check4updates?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=PyPI%20downloads/month
:alt: downloads
:scale: 100%
:target: https://pepy.tech/project/check4updates

.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg?logo=GNU&logoColor=white
:alt: license
:scale: 100%
:target: https://mit-license.org/

0 comments on commit 0bdd43e

Please sign in to comment.