diff --git a/README.md b/README.md new file mode 100644 index 0000000..72cbc8a --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# shuffle3 - 3 stage byte shuffler + +Deterministically and reversably shuffle a file's bytes around. + +## Shuffling +Shuffle a file in place + +``` shell +$ shuffle3 -s file +``` + +## Unshuffling +Unshuffle a file in place + +``` shell +$ shuffle3 -u file +``` + +## Other options +Run with `--help` for more options. + +# License +GPL'd with <3