Initial

README.md

@@ -0,0 +1,29 @@
+# renbin
+
+Split files into chunks and then save them on rentry.co as encrypted, compressed, base64 strings.
+
+## Usage
+
+Split and save file:
+
+```
+renbin -i ./path/to/file.ext -e rentry
+```
+
+Restore file from remote:
+
+```
+renbin -i ./path/to/file.ext.toml -e rentry -d
+```
+
+Delete file and all chunk off remote:
+
+```
+renbin -i ./path/to/file.ext.toml -e rentry -x
+```
+
+### Local
+
+You can also store files locally using `-e fs` (`--engine fs`). This mode is generally **_much_** quicker. This is the mode that will be used by default if no engine flag is provided.
+
+Local files are split into chunks of exactly 200 KB, while the rentry engine splits files into chunks of 150 KB. While larger chunks _could_ be used, that's not as fun.