aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2016-08-13 14:26:22 -0400
committerPaul Duncan <pabs@pablotron.org>2016-08-13 14:26:22 -0400
commit2970d77649cb7abc900077e9ce40bef6f0eec923 (patch)
treec1c461a4e1ab84443264be119b8585bce3b489d4 /README.md
parentee3bcd0190d8a0df91186becb4c71a18639e888e (diff)
downloadzip-crystal-2970d77649cb7abc900077e9ce40bef6f0eec923.tar.bz2
zip-crystal-2970d77649cb7abc900077e9ce40bef6f0eec923.zip
add features and TODO
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index ce61979..d0bbc3f 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,19 @@
Read and write zip archives natively from
[Crystal](http://crystal-lang.org/).
+*Features*
+* Read and write zip files
+* Native Crystal, no dependencies other than zlib
+* ZIP64 support
+* Store and DEFLATE compression
+* UTF-8 filename and comment support (EFS)
+
+*TODO*
+* LZMA and BZip2 compression
+* Encryption (Legacy and Strong Encryption)
+* Split archives (e.g. multi-disk archives)
+* Legacy Unicode support
+
## Installation
Add this to your application's `shard.yml`: