diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000000000000000000000000000000000000..986d0c78b5b64bfac17a890c173753babbab9a64 --- /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 840bf531a96b0fd960ec8adf3abdc4b38415e547..ab48f2cf6adc0237ffaea0c46a771fa410e76340 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