diff --git a/README.md b/README.md index 3a0334e..6847a76 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ You can customize the appearance of the generated HTML files by modifying the ** You can use flags to modify the background, the main, the second, the third color and you can choose how many colors the dither uses. ```bash -bash archiepixa.sh -f "folder" -b "black" -1 "purple" -2 "rgb('22','45','223')" -3 "#342298" -d "5" +bash archiepixa.sh -f "folder" -b "black" -1 "purple" -2 "rgb('22','45','223')" -3 "#342298" -d "5" -F "The footer of the archiepixa magic" ``` Defaults are: @@ -79,6 +79,7 @@ Defaults are: * -3 "black" * -b "white" * -d "3" +* -F none ## Cleanup @@ -89,16 +90,18 @@ To remove the generated HTML files, use the `-r` flag along with the folder name bash archiepixa.sh -f -r ``` -To delete both the HTML files and compressed folders, use the `-ra` flag: +To delete both the HTML files and compressed folders, use the `-R` flag: ```bash -bash archiepixa.sh -f -ra +bash archiepixa.sh -f -R ``` ## IMPORTANT! **Note:** Avoid placing files named "index.html" within the scanned folders to prevent conflicts. +Do **ALWAYS** a backup of what you are scanning with archiepixa. + ## License