From 0729c3a6e2c5f7f9827ba829e81924a0a890ddb1 Mon Sep 17 00:00:00 2001 From: Jaidyn Ann <10477760+JadedCtrl@users.noreply.github.com> Date: Mon, 29 Jan 2024 11:38:54 -0600 Subject: [PATCH] Move README to markdown --- README.md | 29 +++++++++++++++++++++++++++++ README.txt | 32 -------------------------------- 2 files changed, 29 insertions(+), 32 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f307fe --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# azlyrics-fetch +Fetch lyrics from azlyrics.com, simply and quickly. + + +## Installation +Simply copy azlyrics-fetch.sh into your $PATH: +`$ cp azlyrics-fetch.sh ~/.local/bin/` + +### Dependencies +* [Curl](https://curl.se/) +* [Lynx](https://lynx.invisible-island.net/) +* Shell (ksh, bash) + + +## Usage +You can get the lyrics of a specific song like so, replacing $ARTIST and $SONG +with the artist-name and song-name, respectively: + +` $ azlyrics.sh https://www.azlyrics.com/lyrics/$ARTIST/$SONG.html` + +You can get a list of all song URLs of an artist, too: + +`$ azlyrics.sh https://www.azlyrics.com/$A/$ARTIST.*.html` + + +## Meta +License is the [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) +Author is Jaidyn Ann +Sauce is at https://hak.xwx.moe/jadedctrl/azlyrics-fetch diff --git a/README.txt b/README.txt deleted file mode 100644 index 7c5fb3f..0000000 --- a/README.txt +++ /dev/null @@ -1,32 +0,0 @@ -=============================================================================== -AZLYRICS-FETCH -=============================================================================== - -Fetch lyrics from azlyrics.com. - ----------------------------------------- -PRE-REQUISITES ----------------------------------------- -* curl -* lynx -* a shell - ----------------------------------------- -USAGE ----------------------------------------- -AZLYRICS --------------------- -You can get the lyrics of a specific song with - - azlyrics.sh https://www.azlyrics.com/lyrics/$ARTIST/$SONG.html - -You can get a list of all song URLs of an artist with: - - azlyrics.sh https://www.azlyrics.com/$A/$ARTIST.*.html - ----------------------------------------- -BORING STUFF ----------------------------------------- -License is CC-0 -Author is Jaidyn Ann -Sauce is at https://git.feneas.org/detruota/azlyrics-fetch.git