diff --git a/README.md b/README.md index 44c289b..535098b 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,45 @@ A CLI wrapper for the IPS crate. -You can patch a file using the following command: -`ips-rs -i -o ` +## Usage: + +### Help +``` +$ rhack +Patch/Rom hacking utility. + +Usage: rhack + +Commands: + ips Uses IPS patching + xdelta Uses XDELTA patching + help Print this message or the help of the given subcommand(s) + +Options: + -h, --help Print help +``` + +### Patching +``` +$ rhack xdelta +Uses XDELTA patching + +Usage: rhack xdelta [OPTIONS] + +Options: + -i, --input-file File to patch + -p, --patch-file Patch file to use + -o, --output-file Output file + -h, --help Print help + +$ rhack ips +Uses IPS patching + +Usage: rhack ips [OPTIONS] + +Options: + -i, --input-file File to patch + -p, --patch-file Patch file to use + -o, --output-file Output file + -h, --help Print help +```