diff --git a/README.md b/README.md index a731fe3..9bed38b 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,25 @@ Simple CLI that lets users hide secret messages in PNGs. Made for learning purposes. Access to the tutorial followed [here](https://picklenerd.github.io/pngme_book/introduction.html). + +## Usage + +#### Encode a message: +`./pngme encode ` + +Ex: `./pngme encode ./image.png ruSt "psst, this is a secret"` + +#### Decode a message: +`./pngme decode ` + +Ex: `./pngme decode ./image.png ruSt` + +#### Remove a message: +`./pngme remove ` + +Ex: `./pngme remove ./image.png ruSt` + +#### Print the chunks information: +`./pngme print ` + +Ex: `./pngme print ./image.png`