From c985d73858dc4e9d0de3af96f6484931f4e6f938 Mon Sep 17 00:00:00 2001 From: "matthias@arch" Date: Wed, 29 Sep 2021 14:43:58 +0200 Subject: [PATCH] Changed README --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a62f920..9a4ac8f 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ # Nicole - Lyrics Scraper ## Overview -Nicole is a program that searches for lyrics and writes them into the mp3-tag "USLT". +Nicole is a program that searches for lyrics and writes them into the mp3-tag. There is a 5 second delay between each request to azlyrics.com because the site will block your ip if there are too many requests. +### Files +Nicole supports FLAC and mp3 files. Other files can not be edited (as of now). +Files that do not have a .flac or .mp3 extension are skipped automatically. + ### History -Nicole can create a history of all files that were processed in `~/.configs/nicole`. +Nicole creates a history of all files that were processed in `~/.configs/nicole`. If a file is in the history, it will be skipped unless `ignore_history=True`. If the lyrics for a file can not be obtained, it is added to `~/.configs/nicole/failed_files`. Those files are not skipped, the file only exists so that you can see which lyrics were not downloaded. +If you dont want your files in the history, add the `-n` option. + ### azlyrics Nicole creates a azlyrics.com url from the title and artist mp3-tags of the file. The lyrics are extracted from the html document using regex.