From 4b3febe3fe1d706f19af7f8d167f2811ac793996 Mon Sep 17 00:00:00 2001
From: Jerry Liu <jerryjliu98@gmail.com>
Date: Wed, 18 Jan 2023 21:49:52 -0800
Subject: [PATCH] add citation.cff file (#259)
Co-authored-by: Jerry Liu <jerry@robustintelligence.com>
---
CITATION.cff | 10 ++++++++++
README.md | 13 ++++++-------
2 files changed, 16 insertions(+), 7 deletions(-)
create mode 100644 CITATION.cff
diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 0000000000..986d0c78b5
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,10 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Liu"
+ given-names: "Jerry"
+ orcid: "https://orcid.org/0000-0002-6694-3517"
+title: "GPT Index"
+doi: 10.5281/zenodo.1234
+date-released: 2022-11-1
+url: "https://github.com/jerryjliu/gpt_index"
\ No newline at end of file
diff --git a/README.md b/README.md
index 840bf531a9..ab48f2cf6a 100644
--- a/README.md
+++ b/README.md
@@ -89,12 +89,11 @@ All requirements should be contained within the `setup.py` file. To run the pack
Reference to cite if you use GPT Index in a paper:
```
-@misc{Liu2022,
- author = {Liu, Jerry},
- title = {GPT Index},
- year = {2022},
- publisher = {GitHub},
- journal = {GitHub repository},
- howpublished = {\url{https://github.com/jerryjliu/gpt_index}},
+@software{Liu_GPT_Index_2022,
+author = {Liu, Jerry},
+doi = {10.5281/zenodo.1234},
+month = {11},
+title = {{GPT Index}},
+url = {https://github.com/jerryjliu/gpt_index},year = {2022}
}
```
\ No newline at end of file
--
GitLab