matrix-music-bot

commit 8a5aa8e3a5c2256f840d4f18b9918379914ee508
parent 123ad0c4a4672fa340326e10dbb4d4bdd89abea3
Author: John <mail@johnkubach.com>
Date:   Wed, 19 Oct 2022 22:39:57 -0400

Update README

Diffstat:
M
README.md
 | 
11
++++++++++-

1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -10,6 +10,15 @@ or
 
 `./music.py`
 
+## Usage
+
+Once connected to a room, the bot will respond to a message that begins with either
+
+1. A youtube url.
+2. !song [query]
+
+if !song is used, music-bot will fetch the first youtube video relevant the the query. It is best to make the query descriptive, such as artist - title.
+
 ## Requirements
 
 All of the fields in config.ini must be populated in order to use the bot. To
@@ -23,5 +32,5 @@ generate a last.fm api key, [look here](https://www.last.fm/api/authentication).
 
 [youtube_title_parse](https://github.com/lttkgp/youtube_title_parse)
 
-[youtube-dl](https://github.com/ytdl-org/youtube-dl)
+[yt-dlp](https://github.com/ytdl-org/youtube-dl)