From 52b93e2934422b7961c4b20e1e769f543b47ca67 Mon Sep 17 00:00:00 2001 From: Mohammad Momeni Date: Sun, 10 Mar 2024 14:43:09 +0100 Subject: [PATCH] Add Citation section --- CITATION.cff | 9 --------- README.md | 13 +++++++++++++ 2 files changed, 13 insertions(+), 9 deletions(-) delete mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff deleted file mode 100644 index 056763a..0000000 --- a/CITATION.cff +++ /dev/null @@ -1,9 +0,0 @@ -cff-version: 1.2.0 -message: "If you use this software, please cite it as below." -authors: -- family-names: "Mohammad" - given-names: "Momeni" -title: "syncedlyrics" -version: 0.8.0 -date-released: 2022-11-26 -url: "https://github.com/moehmeni/syncedlyrics" diff --git a/README.md b/README.md index 9ba3c88..83e9ae0 100644 --- a/README.md +++ b/README.md @@ -47,3 +47,16 @@ Feel free to suggest more providers or make PRs to fix the broken ones. ## License [MIT](https://github.com/rtcq/syncedlyrics/blob/master/LICENSE) + +## Citation +If you use this library in your research, you can cite as follows: +``` +@misc{syncedlyrics, + author = {Momeni, Mohammad}, + title = {syncedlyrics}, + year = {2022}, + publisher = {GitHub}, + journal = {GitHub repository}, + howpublished = {\url{https://github.com/moehmeni/syncedlyrics}}, +} +```