From d63c510a12f416854bd55bb41acfda78b2833460 Mon Sep 17 00:00:00 2001
From: Guillaume Dalle <22795598+gdalle@users.noreply.github.com>
Date: Wed, 20 Nov 2024 10:29:15 +0100
Subject: [PATCH] Add citation to README (#124)

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 96149bb..b809705 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,26 @@ This package is **reliable**.
 It gives the same results as the previous reference package up to numerical accuracy.
 The test suite incorporates quality checks as well as type stability and allocation analysis.
 
+## Citation
+
+If this package is useful to your research, please cite the [JOSS paper](https://joss.theoj.org/papers/10.21105/joss.06436#). Here is the BibTeX key:
+
+```bibtex
+@article{
+    Dalle2024,
+    doi = {10.21105/joss.06436},
+    url = {https://doi.org/10.21105/joss.06436},
+    year = {2024},
+    publisher = {The Open Journal},
+    volume = {9},
+    number = {96},
+    pages = {6436},
+    author = {Guillaume Dalle},
+    title = {HiddenMarkovModels.jl: generic, fast and reliable state space modeling},
+    journal = {Journal of Open Source Software}
+}
+```
+
 ## Contributing
 
 If you spot a bug or want to ask about a new feature, please [open an issue](https://github.com/gdalle/HiddenMarkovModels.jl/issues) on the GitHub repository.