Update citation links

ganslate-team · Sep 8, 2021 · 997fe2e · 997fe2e
1 parent 19b202c
commit 997fe2e
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 14 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,14 @@
+cff-version: 1.1.0
+message: "If you use this software, please cite it as below."
+authors:
+  - family-names: Hadzic
+    given-names: Ibrahim
+  - family-names: Pai
+    given-names: Suraj
+  - family-names: Rao
+    given-names: Chinmay
+  - family-names: Teuwen
+    given-names: Jonas    
+title: ganslate-team/ganslate: Initial public release
+version: v0.1.0
+date-released: 2017-12-1
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5494572.svg)](https://doi.org/10.5281/zenodo.5494572)
+
 # ganslate - simple and extensible GAN image-to-image translation framework.
 
 For comprehensive documentation, visit: https://ganslate.readthedocs.io/en/latest/
@@ -36,12 +38,17 @@ A [PyTorch](https://pytorch.org/) framework which aims to make GAN image-to-imag
 If you used `ganslate` in your project, please cite:
 
 ```text
-@misc{ganslate,
-  author = {ganslate-team},
-  doi = {},
-  month = {9},
-  title = {{ganslate - simple and extensible GAN image-to-image framework }},
-  url = {https://github.com/ganslate-team/ganslate},
-  year = {2020}
+@software{ibrahim_hadzic_2021_5494572,
+  author       = {Ibrahim Hadzic and
+                  Suraj Pai and
+                  Chinmay Rao and
+                  Jonas Teuwen},
+  title        = {ganslate-team/ganslate: Initial public release},
+  month        = sep,
+  year         = 2021,
+  publisher    = {Zenodo},
+  version      = {v0.1.0},
+  doi          = {10.5281/zenodo.5494572},
+  url          = {https://doi.org/10.5281/zenodo.5494572}
 }
 ```
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,5 @@
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5494572.svg)](https://doi.org/10.5281/zenodo.5494572)
+
 # ganslate
 
 A [PyTorch](https://pytorch.org/) framework which aims to make GAN image-to-image translation more accessible to both beginner and advanced project with:
@@ -33,12 +35,17 @@ A [PyTorch](https://pytorch.org/) framework which aims to make GAN image-to-imag
 If you used `ganslate` in your project, please cite:
 
 ```text
-@misc{ganslate,
-  author = {ganslate-team},
-  doi = {},
-  month = {9},
-  title = {{ganslate - simple and extensible GAN image-to-image framework }},
-  url = {https://github.com/ganslate-team/ganslate},
-  year = {2020}
+@software{ibrahim_hadzic_2021_5494572,
+  author       = {Ibrahim Hadzic and
+                  Suraj Pai and
+                  Chinmay Rao and
+                  Jonas Teuwen},
+  title        = {ganslate-team/ganslate: Initial public release},
+  month        = sep,
+  year         = 2021,
+  publisher    = {Zenodo},
+  version      = {v0.1.0},
+  doi          = {10.5281/zenodo.5494572},
+  url          = {https://doi.org/10.5281/zenodo.5494572}
 }
 ```