From 741a5d05f614954eb2b88bf51a100d3ddeae7c51 Mon Sep 17 00:00:00 2001
From: Jaidyn Ann <10477760+JadedCtrl@users.noreply.github.com>
Date: Mon, 29 Jan 2024 13:42:43 -0600
Subject: [PATCH] Update README and addresses

---
 README.md  | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.txt | 51 ---------------------------------------------------
 wydir      |  2 +-
 wyrics     |  2 +-
 4 files changed, 56 insertions(+), 53 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..0c3d883
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# Wyrics
+
+Shell script for fetching a song’s lyrics from [lyrics.ovh](https://lyrics.ovh).
+
+Previously, this used to use [songlyrics.com](https://songlyrics.com) — and
+before that, [lyrics.wikia.com](https://lyrics.wikia.com). At least, until
+lyrics.wikia.com was axed for copyright-related reasons.
+
+songlyrics.com had more flexible searching (you could make typos), but it
+was a pretty slow site. lyrics.ovh is a good deal faster, but much more picky.
+It’s also libre, and beautiful.  
+Check out [lyrics.ovh’s repo](https://github.com/NTag/lyrics.ovh)!
+
+
+## Installation
+Simply copy wydir and wyrics into your `$PATH`; somewhere like `/usr/local/bin` or
+`~/.local/bin`.  
+`$ cp wydir wyrics ~/.local/bin/`
+
+
+## Dependencies
+You’ll need:
+* [curl](https://curl.se)
+* Shell (ksh, bash)
+
+
+## Usage
+### Wyrics
+Run `wyrics` like so, replacing “$ARTIST” and “$SONG” with your artist and song,
+respectively:
+
+`$ wyrics $ARTIST $SONG`
+
+If you want to save lyrics to a file, you’ll need to redirect the
+output:
+
+`$ wyrics "dream theater" "octavarium" > lyrics.txt`
+
+
+### Wydir
+Wydir runs `wyrics` over every song in a directory of a given file-extension.
+Each song’s lyrics are written to a `.txt` file of the song’s name.
+
+Just run `wydir` like so:
+
+`$ wydir $ARTIST $FILE_EXTENSION`
+
+It’s convenient if you wanna get the lyrics of an album in one go.
+
+
+## Meta
+License is CC0.  
+Author is Jaidyn Ann <jadedctrl@posteo.at>  
+Sauce is at https://hak.xwx.moe/jadedctrl/wyrics
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 94c60d1..0000000
--- a/README.txt
+++ /dev/null
@@ -1,51 +0,0 @@
-===============================================================================
-WYRICS                                                          Git some lyrics
-===============================================================================
-
-Fetch lyrics for a song from lyrics.ovh with this script.
-
-This used to use songlyrics.com-- and before that, lyrics.wikia.com.
-songlyrics.com has more flexible searching (you could make typos), but it
-is a pretty slow site.
-
-lyrics.ovh is a good deal faster, but much more picky.
-
-----------------------------------------
-PRE-REQUISITES
-----------------------------------------
-You'll need:
-	* curl
-	* a shell 
-
-----------------------------------------
-USAGE
-----------------------------------------
-WYRICS
---------------------
-Just run "wyrics" like so:
-
-	wyrics $ARTIST $SONG
-
-If you want to save lyrics to a file, you'll need to redirect the
-output--
-	$ wyrics "dream theater" "octavarium" > lyrics.txt
-
-
-WYDIR
---------------------
-Runs "wyrics" over every song in a directory of a given file-extension.
-The lyrics are output to "$song.txt"
-
-Just run "wydir" like so:
-
-	wydir $ARTIST $FILE_EXTENSION
-
-Convenient if you wanna get the lyrics of an album in one go. 
-
-
-----------------------------------------
-BORING STUFF
-----------------------------------------
-License is CC-0 
-Author is Jaidyn Ann <jadedctrl@teknik.io>
-Sauce is at https://git.feneas.org/detruota/wyrics.git
diff --git a/wydir b/wydir
index a175249..948d12e 100755
--- a/wydir
+++ b/wydir
@@ -4,7 +4,7 @@
 # desc: run `wyrics` over every song in
 #       a directory of given file-ext
 # main: Jaidyn Ann
-#       <jadedctrl@teknik.io>
+#       <jadedctrl@posteo.at>
 # lisc: CC 0
 ########################################
 
diff --git a/wyrics b/wyrics
index d512ab3..8af7ae8 100755
--- a/wyrics
+++ b/wyrics
@@ -3,7 +3,7 @@
 # name: wyrics
 # desc: fetch lyrics from lyrics.ovh
 # main: Jaidyn Ann
-#       <jadedctrl@teknik.io>
+#       <jadedctrl@posteo.at>
 # lisc: CC 0
 ########################################