Merge pull request #28 from decargroup/feature/27-update-readme-with-zenodo-information

Update readme with Zenodo information

Author: sdahdah

CITATION.cff

@@ -10,5 +10,5 @@ authors:
     orcid: "https://orcid.org/0000-0002-1987-9268"
     affiliation: "McGill University"
 title: "decargroup/dkpy"
-version: v0.1.6
+version: v0.1.7
 url: "https://github.com/decargroup/dkpy"

README.rst

@@ -3,6 +3,16 @@
 dkpy
 ====
 
+.. image:: https://github.com/decargroup/dkpy/actions/workflows/test-package.yml/badge.svg
+    :target: https://github.com/decargroup/dkpy/actions/workflows/test-package.yml
+    :alt: Test package
+.. image:: https://readthedocs.org/projects/dkpy/badge/?version=stable
+    :target: https://dkpy.readthedocs.io/en/stable/?badge=stable
+    :alt: Documentation status
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.14511244.svg
+    :target: https://doi.org/10.5281/zenodo.14511244
+    :alt: DOI
+
 ``dkpy`` is a `D-K iteration <https://doi.org/10.1109/ACC.1994.735077>`_
 library written in Python, aiming to build upon
 `python-control <https://github.com/python-control/python-control>`_.
@@ -123,8 +133,10 @@ If you use this software in your research, please cite it as below or see
 
     @software{dahdah_dkpy_2024,
         title={{decargroup/dkpy}},
+        doi={10.5281/zenodo.14511244},
         url={https://github.com/decargroup/dkpy},
+        publisher={Zenodo},
         author={Steven Dahdah and James Richard Forbes},
-        version = {{v0.1.6}},
+        version = {{v0.1.7}},
         year={2024},
     }

doc/conf.py

@@ -9,8 +9,8 @@
 project = "dkpy"
 copyright = "2024, Steven Dahdah and James Richard Forbes"
 author = "Steven Dahdah and James Richard Forbes"
-version = "0.1.6"
-release = "0.1.6"
+version = "0.1.7"
+release = "0.1.7"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "dkpy"
-version = "0.1.6"
+version = "0.1.7"
 dependencies = [
     "numpy>=1.21.0",
     "scipy>=1.7.0",