From 6072ff0c93191d8fe2e0c1a2f16029a620a44657 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Fri, 1 Mar 2024 14:57:02 +0100 Subject: [PATCH] :memo: Update README --- README.rst | 48 ++++++++++++++++++++---------------------------- 1 file changed, 20 insertions(+), 28 deletions(-) diff --git a/README.rst b/README.rst index e9ffad5..bc2ecd7 100644 --- a/README.rst +++ b/README.rst @@ -1,18 +1,17 @@ -Welcome to open_api_framework's documentation! +Welcome to open-api-framework's documentation! ================================================= :Version: 0.1.0 -:Source: https://github.com/maykinmedia/open_api_framework -:Keywords: ```` -:PythonVersion: 3.11 +:Source: https://github.com/maykinmedia/open-api-framework +:Keywords: metapackage, dependencies |build-status| |code-quality| |black| |coverage| |docs| |python-versions| |django-versions| |pypi-version| - +A metapackage for registration components, that bundles the dependencies shared between these components .. contents:: @@ -21,8 +20,7 @@ Welcome to open_api_framework's documentation! Features ======== -* ... -* ... +* Bundling shared dependencies and introducing minimum versions for these dependencies Installation ============ @@ -37,15 +35,9 @@ Requirements Install ------- -.. code-block:: bash - - pip install open_api_framework - - -Usage -===== - - +1. Add open-api-framework to your requirements file +2. Remove dependencies from your requirements file that occur in ``pyproject.toml`` +3. Recompile the dependencies Local development ================= @@ -67,28 +59,28 @@ directory to the python path (or use ``python -m django ``): # django-admin makemessages -l nl -.. |build-status| image:: https://github.com/maykinmedia/open_api_framework/workflows/Run%20CI/badge.svg +.. |build-status| image:: https://github.com/maykinmedia/open-api-framework/workflows/Run%20CI/badge.svg :alt: Build status - :target: https://github.com/maykinmedia/open_api_framework/actions?query=workflow%3A%22Run+CI%22 + :target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Run+CI%22 -.. |code-quality| image:: https://github.com/maykinmedia/open_api_framework/workflows/Code%20quality%20checks/badge.svg +.. |code-quality| image:: https://github.com/maykinmedia/open-api-framework/workflows/Code%20quality%20checks/badge.svg :alt: Code quality checks - :target: https://github.com/maykinmedia/open_api_framework/actions?query=workflow%3A%22Code+quality+checks%22 + :target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Code+quality+checks%22 .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black -.. |coverage| image:: https://codecov.io/gh/maykinmedia/open_api_framework/branch/main/graph/badge.svg - :target: https://codecov.io/gh/maykinmedia/open_api_framework +.. |coverage| image:: https://codecov.io/gh/maykinmedia/open-api-framework/branch/main/graph/badge.svg + :target: https://codecov.io/gh/maykinmedia/open-api-framework :alt: Coverage status -.. |docs| image:: https://readthedocs.org/projects/open_api_framework/badge/?version=latest - :target: https://open_api_framework.readthedocs.io/en/latest/?badge=latest +.. |docs| image:: https://readthedocs.org/projects/open-api-framework/badge/?version=latest + :target: https://open-api-framework.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status -.. |python-versions| image:: https://img.shields.io/pypi/pyversions/open_api_framework.svg +.. |python-versions| image:: https://img.shields.io/pypi/pyversions/open-api-framework.svg -.. |django-versions| image:: https://img.shields.io/pypi/djversions/open_api_framework.svg +.. |django-versions| image:: https://img.shields.io/pypi/djversions/open-api-framework.svg -.. |pypi-version| image:: https://img.shields.io/pypi/v/open_api_framework.svg - :target: https://pypi.org/project/open_api_framework/ +.. |pypi-version| image:: https://img.shields.io/pypi/v/open-api-framework.svg + :target: https://pypi.org/project/open-api-framework/