Update readme after test pypi #65

.github/workflows/codecov.yml

@@ -5,7 +5,7 @@ name: codecov
 
 on: 
   push:
-    branches: [ production, develop, feature-61-codecov ]
+    branches: [ production, develop ]
 
 jobs:
   test:

MANIFEST.in

@@ -0,0 +1,6 @@
+exclude .gitignore
+exclude .pre-commit-config.yaml
+exclude tox.ini
+
+prune .github
+prune tests

README.rst

@@ -22,7 +22,7 @@ super-repo
    * - Documentation
      - |badge_documentation| |badge_codecov|
    * - Publication
-     -
+     - |badge_pypi| |badge_python| |badge_pypi_downloads|
    * - Development
      - |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
    * - Community
@@ -41,21 +41,26 @@ Introduction
 
 Documentation
 =============
-| The documentation is created with Markdown using `MkDocs <https://www.mkdocs.org/>`_.
+| The documentation is created with Markdown using `MkDocs <https://www.mkdocs.org/>`_ and `mike <https://github.com/jimporter/mike>`_.
 | All files are stored in the ``docs`` folder of the repository.
-| A **GitHub Actions** deploys the ``production`` branch on a **GitHub Page**.
-| The documentation page is `rl-institut.github.io/super-repo/ <https://rl-institut.github.io/super-repo/>`_
+| A **GitHub Actions** deploys the ``develop`` branch on a **GitHub Page**.
+| The documentation page is: `rl-institut.github.io/super-repo/ <https://rl-institut.github.io/super-repo/>`_
 
 Collaboration
 =============
 | Everyone is invited to develop this repository with good intentions.
-| Please follow the workflow described in the `CONTRIBUTING.md <CONTRIBUTING.md>`_.
+| Please follow the workflow described in the `CONTRIBUTING.md <https://rl-institut.github.io/super-repo/latest/development/collaboration/>`_.
+
+.. figure:: https://contrib.rocks/image?repo=rl-institut/super-repo
+    :align: left
+    :target: https://github.com/rl-institut/super-repo/graphs/contributors
+    :alt: [contrib.rocks](https://contrib.rocks)
 
 License and Citation
 ====================
 | The code of this repository is licensed under the **MIT License** (MIT).
 | See `LICENSE.txt <LICENSE.txt>`_ for rights and obligations.
-| See the *Cite this repository* function or `CITATION.cff <CITATION.cff>`_ for citation of this repository.
+| See the *Cite this repository* function or `CITATION.cff <https://github.com/rl-institut/super-repo/blob/production/CITATION.cff>`_ for citation of this repository.
 | Copyright: `super-repo <https://github.com/rl-institut/super-repo/>`_ © `Reiner Lemoine Institut <https://reiner-lemoine-institut.de/>`_ | `MIT <LICENSE.txt>`_
 
 
@@ -67,33 +72,52 @@ License and Citation
     :target: https://api.reuse.software/info/github.com/rl-institut/super-repo
     :alt: REUSE
 
-.. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/rl-institut/super-repo/gh-pages.yml?branch=production
+.. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/rl-institut/super-repo/documentation.yml?branch=develop
     :target: https://rl-institut.github.io/super-repo/
     :alt: Documentation
 
-.. |badge_codecov| image:: https://codecov.io/gh/rl-institut/super-repo/branch/feature-61-codecov/graph/badge.svg?token=YYCJI3D5G5
+.. |badge_codecov| image:: https://codecov.io/gh/rl-institut/super-repo/graph/badge.svg?token=YYCJI3D5G5
     :target: https://codecov.io/gh/rl-institut/super-repo
     :alt: Codecov
 
+.. |badge_pypi| image:: https://img.shields.io/pypi/v/super-repo
+    :target: https://pypi.org/project/super-repo/
+    :alt: PyPI Version
+
+.. |badge_python| image:: https://img.shields.io/pypi/pyversions/super-repo
+    :target: https://pypi.org/project/super-repo/
+    :alt: PyPI Python Version
+
+.. |badge_pypi_downloads| image:: https://img.shields.io/pypi/dm/super-repo
+    :target: https://pypi.org/project/super-repo/
+    :alt: PyPI Downloads
+
 .. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
+    :target: https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md
     :alt: contributions
 
 .. |badge_repo_counts| image:: http://hits.dwyl.com/rl-institut/super-repo.svg
+    :target: http://hits.dwyl.com/rl-institut/super-repo
     :alt: counter
 
-.. |badge_contributors| image:: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square
+.. |badge_contributors| image:: https://img.shields.io/github/contributors/rl-institut/super-repo
+    :target: https://github.com/rl-institut/super-repo/graphs/contributors
     :alt: contributors
 
 .. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/rl-institut/super-repo
+    :target: https://github.com/rl-institut/super-repo/issues
     :alt: open issues
 
 .. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/rl-institut/super-repo
+    :target: https://github.com/rl-institut/super-repo/issues?q=is%3Aissue+is%3Aclosed
     :alt: closes issues
 
 .. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/rl-institut/super-repo
+    :target: https://github.com/rl-institut/super-repo/pulls
     :alt: closes issues
 
 .. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/rl-institut/super-repo
+    :target: https://github.com/rl-institut/super-repo/pulls?q=is%3Apr+is%3Aclosed
     :alt: closes issues
 
 .. |badge_matrix| image:: https://img.shields.io/matrix/super-repo:matrix.org

RELEASE_PROCEDURE.md

@@ -179,17 +179,21 @@ If you messed up, remove tags and start again
 
 ### 1. 💻 Create and publish package on PyPI
 
-- Navigate to git folder `cd D:\git\github\GROUP\REPO\`
-- Create package using `python setup.py sdist`
-- Check that file has been created in folder `dist`
-- Activate python environment `activate release_py38`
-- Upload to PyPI using `twine upload dist/NAME_0.5.1.tar.gz`
-- Enter `name` and `password`
-- Check on PyPI if release arrived
-- Breath three times and smile
+💻 `cd D:\git\github\USER\REPO\` Navigate to git folder <br>
+💻 `activate py310` Activate conda environment <br>
+💻 `python -m build` Create package using <br>
+📝 `dist` Check that files have been created in folder <br>
+💻 `twine check dist/*` Check build <br>
+💻 `twine upload -r testpypi dist/NAME_0.2.0.tar.gz` Upload to Test PyPI using <br>
+💻 `twine upload dist/NAME_0.2.0.tar.gz` Upload to PyPI using <br>
+💻 Enter `name` and `password` <br>
+🎉 Check on PyPI if release arrived, breath three times and smile!
 
 ▶️ Publish the Package
 
 ## Sources:
 
 - https://raw.githubusercontent.com/folio-org/stripes/master/doc/release-procedure.md
+
+!!! note "Used Icons"
+    🐙 GitHub | 💠 git | 📝 File | 💻 Command Line