Added a basic README.

2016-06-07 17:52:06 +02:00
parent 7309717303
commit a18a709a76
2 changed files with 17 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,17 @@
+# PI Archive
+
+Only works for single files, and is slooooooow. And when I say slow, I mean really slow.
+And the compression rate? Not so god, in fact, the result is larger than the original.
+But hey, it works! And it's using freaking PI!!!
+
+## Compress
+
+```shell
+$ piar -c my_file.txt my_file.pi
+```
+
+## Decompress
+
+```shell
+$ piar -d my_file.pi my_file.txt
+```