Skip to content

Commit 63261e7

Browse files
committed
📝 Improved Readme
1 parent 2e4065e commit 63261e7

File tree

1 file changed

+26
-17
lines changed

1 file changed

+26
-17
lines changed

README.rst

+26-17
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,18 @@ Open Archiefbeheer
44

55
:Version: 0.1.0
66
:Source: https://github.com/maykinmedia/open-archiefbeheer
7-
:Keywords: ``<keywords>``
8-
:PythonVersion: 3.11
7+
:Keywords: ``open-archiefbeheer archiveren zaken``
8+
:PythonVersion: 3.12
99

10-
|build-status| |requirements|
10+
|build-status| |code-quality| |black| |coverage| |python-versions| |docker|
1111

12-
``<oneliner describing the project>``
13-
14-
Developed by `Maykin Media B.V.`_ for ``<client>``
12+
Open Archiefbeheer is an app to manage the archiving process of cases.
1513

1614

1715
Introduction
1816
============
1917

20-
``<describe the project in a few paragraphs and briefly mention the features>``
18+
# To do
2119

2220

2321
Documentation
@@ -27,20 +25,31 @@ See ``INSTALL.rst`` for installation instructions, available settings and
2725
commands.
2826

2927

30-
References
31-
==========
32-
33-
* `Issues <https://taiga.maykinmedia.nl/project/openarchiefbeheer>`_
28+
* `Issues <https://github.com/maykinmedia/open-archiefbeheer/issues>`_
3429
* `Code <https://github.com/maykinmedia/open-archiefbeheer>`_
3530

3631

37-
.. |build-status| image:: http://jenkins.maykin.nl/buildStatus/icon?job=bitbucket/openarchiefbeheer/master
32+
.. _Maykin Media B.V.: https://www.maykinmedia.nl
33+
34+
.. |build-status| image:: https://github.com/maykinmedia/open-archiefbeheer/actions/workflows/ci.yml/badge.svg
3835
:alt: Build status
39-
:target: http://jenkins.maykin.nl/job/openarchiefbeheer
36+
:target: https://github.com/maykinmedia/open-archiefbeheer/actions/workflows/ci.yml
4037

41-
.. |requirements| image:: https://requires.io/bitbucket/maykinmedia/openarchiefbeheer/requirements.svg?branch=master
42-
:target: https://requires.io/bitbucket/maykinmedia/openarchiefbeheer/requirements/?branch=master
43-
:alt: Requirements status
38+
.. |code-quality| image:: https://github.com/maykinmedia/open-archiefbeheer/actions/workflows/code_quality.yml/badge.svg
39+
:alt: Code quality checks
40+
:target: https://github.com/maykinmedia/open-archiefbeheer/actions/workflows/code_quality.yml
4441

42+
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
43+
:alt: Code style
44+
:target: https://github.com/psf/black
4545

46-
.. _Maykin Media B.V.: https://www.maykinmedia.nl
46+
.. |coverage| image:: https://codecov.io/github/maykinmedia/open-archiefbeheer/branch/main/graphs/badge.svg?branch=main
47+
:alt: Coverage
48+
:target: https://codecov.io/gh/maykinmedia/open-archiefbeheer
49+
50+
.. |python-versions| image:: https://img.shields.io/badge/python-3.10-blue.svg
51+
:alt: Supported Python versions
52+
53+
.. |docker| image:: https://img.shields.io/docker/v/maykinmedia/open-archiefbeheer?sort=semver
54+
:alt: Docker image
55+
:target: https://hub.docker.com/r/maykinmedia/open-archiefbeheer

0 commit comments

Comments
 (0)