Merge pull request #5 from embedchain/add-citation

update: add citation
mem0ai · Jul 5, 2023 · d8b439d · d8b439d
2 parents 571f000 + eb9d3bd
commit d8b439d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,8 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Singh"
+  given-names: "Taranjeet"
+title: "Embedchain"
+date-released: 2023-06-25
+url: "https://github.com/embedchain/embedchainjs"
diff --git a/README.md b/README.md
@@ -214,3 +214,17 @@ embedchain is built on the following stack:
 
 - [cachho](https://github.com/cachho)
 - [sahilyadav902](https://github.com/sahilyadav902)
+
+## Citation
+
+If you utilize this repository, please consider citing it with:
+```
+@misc{embedchain,
+  author = {Taranjeet Singh},
+  title = {Embechain: Framework to easily create LLM powered bots over any dataset},
+  year = {2023},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/embedchain/embedchainjs}},
+}
+```