Updated docs to allow eventual BibTeX citations for the project (#55)

poets-ai · Jul 21, 2020 · 12672dc · 12672dc
1 parent de72282
commit 12672dc
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -103,3 +103,21 @@ We are a couple friends passionate about ML.
 
 ## License
 Apache
+
+## Citing Elegy
+
+To cite this project:
+
+**BibTeX**
+
+```
+@software{elegy2020repository,
+author = {PoetsAI},
+title = {Elegy: A Keras-like deep learning framework based on Jax & Haiku},
+url = {https://github.com/poets-ai/elegy},
+version = {0.1.3},
+year = {2020},
+}
+```
+
+Where the current *version* may be retrieved either from the `Release` tag or the file [elegy/\_\_init\_\_.py](https://github.com/poets-ai/elegy/blob/master/elegy/__init__.py) and the *year* corresponds to the project's release year.
diff --git a/docs/index.md b/docs/index.md
@@ -102,3 +102,21 @@ We are a couple friends passionate about ML.
 
 ## License
 Apache
+
+## Citing Elegy
+
+To cite this project:
+
+**BibTeX**
+
+```
+@software{elegy2020repository,
+author = {PoetsAI},
+title = {Elegy: A Keras-like deep learning framework based on Jax & Haiku},
+url = {https://github.com/poets-ai/elegy},
+version = {0.1.3},
+year = {2020},
+}
+```
+
+Where the current *version* may be retrieved either from the `Release` tag or the file [elegy/\_\_init\_\_.py](https://github.com/poets-ai/elegy/blob/master/elegy/__init__.py) and the *year* corresponds to the project's release year.