Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BeeMargarida committed Dec 6, 2022
1 parent 68ed034 commit 261b77f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <png path> <chunk type> <message> <output path (optional)>`

Ex: `./pngme encode ./image.png ruSt "psst, this is a secret"`

#### Decode a message:
`./pngme decode <png path> <chunk type>`

Ex: `./pngme decode ./image.png ruSt`

#### Remove a message:
`./pngme remove <png path> <chunk type>`

Ex: `./pngme remove ./image.png ruSt`

#### Print the chunks information:
`./pngme print <png path>`

Ex: `./pngme print ./image.png`

0 comments on commit 261b77f

Please sign in to comment.