docs: elaborate on purpose of crate

This commit is contained in:
Marli Frost 2020-08-19 13:33:37 +01:00
parent 4091167222
commit 33cd959b11
No known key found for this signature in database
GPG key ID: CB0BEA7CF9BD1245

View file

@ -1,4 +1,7 @@
//! A basic ZipReader/Writer crate
//! An ergonomic API for reading and writing ZIP files.
//!
//! The current implementation is based on [PKWARE's APPNOTE.TXT v6.3.9](https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT)
// TODO: Decide on the crate's bias: Do we prioritise permissiveness/correctness/speed/ergonomics?
#![warn(missing_docs)]