From 2970d77649cb7abc900077e9ce40bef6f0eec923 Mon Sep 17 00:00:00 2001 From: Paul Duncan Date: Sat, 13 Aug 2016 14:26:22 -0400 Subject: add features and TODO --- README.md | 13 +++++++++++++ src/zip.cr | 13 +++++++++++++ 2 files changed, 26 insertions(+) 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`: diff --git a/src/zip.cr b/src/zip.cr index 6660fc8..4f007db 100644 --- a/src/zip.cr +++ b/src/zip.cr @@ -35,6 +35,19 @@ require "zlib" # # Library for reading and writing zip files. # +# 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 +# # Examples: # # Reading from a zip file: -- cgit v1.2.3