Move README to markdown

This commit is contained in:
Jaidyn Ann 2024-01-29 11:38:54 -06:00
parent ab87df6086
commit 0729c3a6e2
2 changed files with 29 additions and 32 deletions

29
README.md Normal file
View File

@ -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 <jadedctrl@posteo.at>
Sauce is at https://hak.xwx.moe/jadedctrl/azlyrics-fetch

View File

@ -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 <jadedctrl@teknik.io>
Sauce is at https://git.feneas.org/detruota/azlyrics-fetch.git