diff --git a/README.md b/README.md index d93c6bb..b7a8937 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # fortunebot -Open alternative to InspiroBot \ No newline at end of file +Open alternative to InspiroBot + +## A short guide + +To make executable: + +```zsh +chmod +x teller.sh +``` + +To create a quote image: + +```zsh +./teller.sh +``` + +To create a quote image with custom fortune file: + +```zsh +./teller.sh myfortunes # replace "myfortunes" with your fortune file! +``` + +To create a quote image with Samantha making the quotes: + +```zsh +./teller.sh samantha-mode +``` \ No newline at end of file