From d60e079c2f5b79219351e112c8dce179cce91bd3 Mon Sep 17 00:00:00 2001
From: Avril <flanchan@cumallover.me>
Date: Sat, 21 Nov 2020 17:46:04 +0000
Subject: [PATCH] added readme

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

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