From dd95f335bc0f050dc87d0257db9990e1d7553213 Mon Sep 17 00:00:00 2001 From: "matthias@arch" Date: Wed, 29 Sep 2021 04:24:35 +0200 Subject: [PATCH] Fixed README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 80d4af6..a966083 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # Nicole - Lyrics Scraper -##Overview: +## Overview Nicole is a program that searches for lyrics and writes them into the mp3-tag "USLT". 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. -###History: +### History Nicole can create 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. -###azlyrics: +### 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. @@ -38,5 +38,5 @@ python3 -m pip install . ``` You can also install it system-wide using `sudo python3 -m pip install.` -## Importand Notice: +## Importand Notice This software comes with no warranty!