From f9bbcdb0298e509d7431ed8af0283c2072a6090a Mon Sep 17 00:00:00 2001
From: fatih <34196005+fcakyon@users.noreply.github.com>
Date: Tue, 23 Nov 2021 01:24:55 +0300
Subject: [PATCH] add zenodo doi and citation into readme (#280)

* add zenodo doi and citation into readme

* update version in citation

* add citation.cff

* Update CITATION.cff

* Update README.md
---
 CITATION.cff | 21 +++++++++++++++++++++
 README.md    | 25 +++++++++++++++++++++++++
 2 files changed, 46 insertions(+)
 create mode 100644 CITATION.cff

diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 000000000..b71118ae1
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,21 @@
+cff-version: 1.2.0
+message: "If you use this package, please cite it as below."
+authors:
+- family-names: "Akyon"
+  given-names: "Fatih Cagatay"
+- family-names: "Cengiz"
+  given-names: "Cemil"
+- family-names: "Altinuc"
+  given-names: "Sinan Onur"
+- family-names: "Cavusoglu"
+  given-names: "Devrim"
+- family-names: "Sahin"
+  given-names: "Kadir"
+- family-names: "Eryuksel"
+  given-names: "Ogulcan"
+title: "SAHI: A lightweight vision library for performing large scale object detection and instance segmentation"
+doi: 10.5281/zenodo.5718950
+month: nov
+year: 2021
+publisher: Zenodo
+url: "https://doi.org/10.5281/zenodo.5718950"
diff --git a/README.md b/README.md
index 827cb2971..661ee7854 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,8 @@
     <a href="https://badge.fury.io/py/sahi"><img src="https://badge.fury.io/py/sahi.svg" alt="pypi version"></a>
     <a href="https://anaconda.org/conda-forge/sahi"><img src="https://anaconda.org/conda-forge/sahi/badges/version.svg" alt="conda version"></a>
     <a href="https://github.com/obss/sahi/actions?query=event%3Apush+branch%3Amain+is%3Acompleted+workflow%3ACI"><img src="https://github.com/obss/sahi/workflows/CI/badge.svg" alt="ci"></a>
+    <br>
+    <a href="https://doi.org/10.5281/zenodo.5718950"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.5718950.svg" alt="ci"></a>
 </div>
 </div>
 
@@ -422,6 +424,29 @@ mot_video.export(export_dir="mot_gt", type="gt")
 
 <b>Find detailed info on MOT utilities (ground truth dataset creation, exporting tracker metrics in mot challenge format) at [MOT.md](docs/MOT.md).</b>
 
+## <div align="center">Citation</div>
+
+If you use this package in your work, please cite it as:
+
+```
+@software{akyon2021sahi,
+  author       = {Akyon, Fatih Cagatay and
+                  Cengiz, Cemil and
+                  Altinuc, Sinan Onur and
+                  Cavusoglu, Devrim and
+                  Sahin, Kadir and
+                  Eryuksel, Ogulcan},
+  title        = {{SAHI: A lightweight vision library for performing 
+                   large scale object detection and instance
+                   segmentation}},
+  month        = nov,
+  year         = 2021,
+  publisher    = {Zenodo},
+  doi          = {10.5281/zenodo.5718950},
+  url          = {https://doi.org/10.5281/zenodo.5718950}
+}
+```
+
 ## <div align="center">Contributing</div>
 
 `sahi` library currently supports all [YOLOv5 models](https://github.com/ultralytics/yolov5/releases) and [MMDetection models](https://github.com/open-mmlab/mmdetection/blob/master/docs/model_zoo.md). Moreover, it is easy to add new frameworks.