Skip to content

Commit

Permalink
Add citations.cff and update readme with badges
Browse files Browse the repository at this point in the history
  • Loading branch information
xhlulu committed Aug 21, 2021
1 parent 45f8d86 commit 3158548
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 2 deletions.
11 changes: 11 additions & 0 deletions CITATIONS.cff
Original file line number Diff line number Diff line change
@@ -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"
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include CITATIONS.cff
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)<br>
📚 [Documentation](https://git.io/dlt-docs) / [Readthedocs](https://dl-translate.readthedocs.io)<br>
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 3158548

Please sign in to comment.