From 2620b1c60db59a848c64cfd64291503cdee78f52 Mon Sep 17 00:00:00 2001
From: Ernst Leierzopf <ernst.leierzopf@ins.jku.at>
Date: Tue, 17 Sep 2024 14:29:29 +0200
Subject: [PATCH] add CITATION.cff and BibTeX citations in README.

---
 CITATION.cff | 20 ++++++++++++++++++++
 README.md    | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 52 insertions(+)
 create mode 100644 CITATION.cff

diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 0000000..c239bd4
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+title: A Massive Machine-Learning Approach For Classical Cipher Type Detection Using
+  Feature Engineering
+message: If you use this software, please cite it as below.
+author:
+- given-name: Ernst
+  family-name: Leierzopf
+- given-name: Nils
+  family-name: Kopal
+- given-name: Bernhard
+  family-name: Esslinger
+- given-name: Harald
+  family-name: Lampesberger
+- given-name: Eckehard
+  family-name: Hermann
+doi: 10.3384/ecp183164
+url: https://ecp.ep.liu.se/index.php/histocrypt/article/view/164
+license: "CC BY 4.0"
+version: 1.0
+date-released: '2022-06-09'
diff --git a/README.md b/README.md
index b63f391..8ce6547 100644
--- a/README.md
+++ b/README.md
@@ -206,3 +206,35 @@ AusDM 2021: Detection of Classical Cipher Types with Feature-Learning  Approache
 
 - [Proceedings](https://link.springer.com/book/10.1007/978-981-16-8531-6)
 - [Pre-Print](https://www.cryptool.org/download/ncid/Detect-Classical-Cipher-Types-with-Feature-Learning_AusDM2021_PrePrint.pdf)
+
+## BibTeX Citation
+
+If you use ncid in a scientific publication, we would appreciate using the following citations:
+
+```
+@inproceedings{leierzopf2021-2,
+author="Leierzopf, Ernst and Mikhalev, Vasily and Kopal, Nils and Esslinger, Bernhard and Lampesberger, Harald and Hermann, Eckehard",
+editor="Xu, Yue and Wang, Rosalindand Lord, Anton and Boo, Yee Ling and Nayak, Richi and Zhao, Yanchang and Williams, Graham",
+title="Detection of Classical Cipher Types with Feature-Learning Approaches",
+booktitle="Data Mining",
+year="2021",
+month="Dec",
+publisher="Springer Singapore",
+address="Singapore",
+pages="152--164",
+isbn="978-981-16-8531-6",
+url="https://link.springer.com/chapter/10.1007/978-981-16-8531-6_11",
+doi="10.1007/978-981-16-8531-6_11"
+}
+
+@inproceedings{leierzopf2021-1,
+title = "A Massive Machine-Learning Approach For Classical Cipher Type Detection Using Feature Engineering",
+author = "Ernst Leierzopf and Nils Kopal and Bernhard Esslinger and Harald Lampesberger and Eckehard Hermann",
+year = "2021",
+month = aug,
+doi = "10.3384/ecp183164",
+language = "English",
+pages = "111--120",
+booktitle = "Proceedings of the 4th International Conference on Historical Cryptology",
+}
+```