From ed7ffac27b04a283bf7d0f9bd6de44da8c8adaac Mon Sep 17 00:00:00 2001
From: Max Rossmannek <oss@zurich.ibm.com>
Date: Fri, 6 Sep 2024 17:09:21 +0200
Subject: [PATCH] docs: add citation info (#4)

(cherry picked from commit 2012e8ba2520f349f936350334f1c0628a569138)
---
 CITATION.bib   | 12 ++++++++++++
 README.md      | 11 +++++++++--
 docs/index.rst |  5 +++++
 3 files changed, 26 insertions(+), 2 deletions(-)
 create mode 100644 CITATION.bib

diff --git a/CITATION.bib b/CITATION.bib
new file mode 100644
index 0000000..40afd32
--- /dev/null
+++ b/CITATION.bib
@@ -0,0 +1,12 @@
+@software{qiskit-addon-utils,
+    author = {
+        Rossmannek, Max and
+        Garrison, James R. and
+        Johnson, Caleb
+    },
+    title = {{Qiskit addon utils}},
+    year = 2024,
+    publisher = {Zenodo},
+    doi = {10.5281/zenodo.13711854},
+    url = {https://doi.org/10.5281/zenodo.13711854}
+}
diff --git a/README.md b/README.md
index 94050a1..365033c 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
   [![Qiskit](https://img.shields.io/badge/Qiskit%20-%20%3E%3D1.2%20-%20%236133BD?logo=Qiskit)](https://github.com/Qiskit/qiskit)
 <br />
   [![Docs (stable)](https://img.shields.io/badge/%F0%9F%93%84%20Docs-stable-blue.svg)](https://qiskit.github.io/qiskit-addon-utils/)
-  <!--[![DOI](https://zenodo.org/badge/TODO.svg)](https://zenodo.org/badge/latestdoi/TODO)-->
+  [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13711854.svg)](https://zenodo.org/doi/10.5281/zenodo.13711854)
   [![License](https://img.shields.io/github/license/Qiskit/qiskit-addon-utils?label=License)](LICENSE.txt)
   [![Downloads](https://img.shields.io/pypi/dm/qiskit-addon-utils.svg?label=Downloads)](https://pypi.org/project/qiskit-addon-utils/)
   [![Tests](https://github.com/Qiskit/qiskit-addon-utils/actions/workflows/test_latest_versions.yml/badge.svg)](https://github.com/Qiskit/qiskit-addon-utils/actions/workflows/test_latest_versions.yml)
@@ -22,6 +22,7 @@
 * [Installation](#installation)
 * [Deprecation Policy](#deprecation-policy)
 * [Contributing](#contributing)
+* [Citation](#citation)
 * [License](#license)
 
 ----------------------------------------------------------------------------------------------------
@@ -70,7 +71,7 @@ Each substantial improvement, breaking change, or deprecation will be documented
 
 The source code is available [on GitHub](https://github.com/Qiskit/qiskit-addon-utils).
 
-The developer guide is located at [CONTRIBUTING.md](https://github.com/Qiskit/qiskit-addon-utils/blob/main/CONTRIBUTING.md>)
+The developer guide is located at [CONTRIBUTING.md](https://github.com/Qiskit/qiskit-addon-utils/blob/main/CONTRIBUTING.md)
 in the root of this project's repository.
 By participating, you are expected to uphold Qiskit's [code of conduct](https://github.com/Qiskit/qiskit/blob/main/CODE_OF_CONDUCT.md).
 
@@ -78,6 +79,12 @@ We use [GitHub issues](https://github.com/Qiskit/qiskit-addon-utils/issues/new/c
 
 ----------------------------------------------------------------------------------------------------
 
+### Citation
+
+If you use this package in your research, please cite it according to the [CITATION.bib](https://github.com/Qiskit/qiskit-addon-utils/blob/main/CITATION.bib) file.
+
+----------------------------------------------------------------------------------------------------
+
 ### License
 
 [Apache License 2.0](LICENSE.txt)
diff --git a/docs/index.rst b/docs/index.rst
index ae6e532..49ad196 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -47,6 +47,11 @@ By participating, you are expected to uphold Qiskit's `code of conduct <https://
 
 We use `GitHub issues <https://github.com/Qiskit/qiskit-addon-utils/issues/new/choose>`_ for tracking requests and bugs.
 
+Citation
+--------
+
+If you use this package in your research, please cite it according to the `CITATION.bib <https://github.com/Qiskit/qiskit-addon-utils/blob/main/CITATION.bib>`_ file.
+
 License
 -------