Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.

Commit

Permalink
📝 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenbal committed Aug 8, 2024
1 parent 1cd0a9c commit 99bb56b
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@


Welcome to stuf_zds_payments's documentation!
Welcome to open-forms-ext-stuf-zds-payments's documentation!
=================================================

:Version: 0.1.0
:Source: https://github.com/maykinmedia/stuf_zds_payments
:Source: https://github.com/open-formulieren/open-forms-ext-stuf-zds-payments
:Keywords: ``<keywords>``
:PythonVersion: 3.10
:PythonVersion: 3.10, 3.12

|build-status| |code-quality| |black| |coverage| |docs|

|python-versions| |django-versions| |pypi-version|

<One liner describing the project>
Extra payment attributes for Open Forms StUF-ZDS registration backend

.. contents::

Expand All @@ -21,16 +21,15 @@ Welcome to stuf_zds_payments's documentation!
Features
========

* ...
* ...
* Extra payment attributes for Open Forms StUF-ZDS registration backend

Installation
============

Requirements
------------

* Python 3.12 or above
* Python 3.10/3.12 or above
* Django 4.2 or newer


Expand All @@ -39,7 +38,7 @@ Install

.. code-block:: bash
pip install stuf_zds_payments
pip install open-forms-ext-stuf-zds-payments
Usage
Expand Down Expand Up @@ -67,19 +66,19 @@ directory to the python path (or use ``python -m django <command>``):
# django-admin makemessages -l nl
.. |build-status| image:: https://github.com/maykinmedia/stuf_zds_payments/workflows/Run%20CI/badge.svg
.. |build-status| image:: https://github.com/open-formulieren/open-forms-ext-stuf-zds-payments/workflows/Run%20CI/badge.svg
:alt: Build status
:target: https://github.com/maykinmedia/stuf_zds_payments/actions?query=workflow%3A%22Run+CI%22
:target: https://github.com/open-formulieren/open-forms-ext-stuf-zds-payments/actions?query=workflow%3A%22Run+CI%22

.. |code-quality| image:: https://github.com/maykinmedia/stuf_zds_payments/workflows/Code%20quality%20checks/badge.svg
.. |code-quality| image:: https://github.com/open-formulieren/open-forms-ext-stuf-zds-payments/workflows/Code%20quality%20checks/badge.svg
:alt: Code quality checks
:target: https://github.com/maykinmedia/stuf_zds_payments/actions?query=workflow%3A%22Code+quality+checks%22
:target: https://github.com/open-formulieren/open-forms-ext-stuf-zds-payments/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/stuf_zds_payments/branch/main/graph/badge.svg
:target: https://codecov.io/gh/maykinmedia/stuf_zds_payments
.. |coverage| image:: https://codecov.io/gh/open-formulieren/open-forms-ext-stuf-zds-payments/branch/main/graph/badge.svg
:target: https://codecov.io/gh/open-formulieren/open-forms-ext-stuf-zds-payments
:alt: Coverage status

.. |docs| image:: https://readthedocs.org/projects/stuf_zds_payments/badge/?version=latest
Expand Down

0 comments on commit 99bb56b

Please sign in to comment.