From 31585488baad10702ebdc12ca9780a7573c67c9a Mon Sep 17 00:00:00 2001 From: xhlulu Date: Sat, 21 Aug 2021 15:09:40 -0400 Subject: [PATCH] Add citations.cff and update readme with badges --- CITATIONS.cff | 11 +++++++++++ MANIFEST.in | 1 + README.md | 7 ++++++- setup.py | 2 +- 4 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 CITATIONS.cff create mode 100644 MANIFEST.in diff --git a/CITATIONS.cff b/CITATIONS.cff new file mode 100644 index 0000000..6068055 --- /dev/null +++ b/CITATIONS.cff @@ -0,0 +1,11 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: +- family-names: "Lu" + given-names: "Xing Han" + orcid: "https://orcid.org/0000-0001-9027-8425" +title: "DL Translate: A deep learning-based translation library built on Huggingface transformers" +version: 0.2.3 +doi: 10.5281/zenodo.5230676 +date-released: 2021-08-21 +url: "https://github.com/xhlulu/dl-translate" \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..cb79f35 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include CITATIONS.cff \ No newline at end of file diff --git a/README.md b/README.md index e87e617..d191690 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # DL Translate -*A deep learning-based translation library built on Huggingface `transformers` and Facebook's `mBART-Large`* +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5230677.svg)](https://doi.org/10.5281/zenodo.5230677) +[![Downloads](https://static.pepy.tech/personalized-badge/dl-translate?period=total&units=abbreviation&left_color=grey&right_color=orange&left_text=Downloads)](https://pepy.tech/project/dl-translate) +[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/xhlulu/dl-translate/blob/main/LICENSE) + + +*A deep learning-based translation library built on Huggingface `transformers`* 💻 [GitHub Repository](https://github.com/xhlulu/dl-translate)
📚 [Documentation](https://git.io/dlt-docs) / [Readthedocs](https://dl-translate.readthedocs.io)
diff --git a/setup.py b/setup.py index 05f99ed..d31b2b5 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="dl-translate", - version="0.2.2", + version="0.2.3", author="Xing Han Lu", author_email="github@xinghanlu.com", description="A deep learning-based translation library built on Huggingface transformers",