From 33cd959b11e41f4373c149f4afee88c4d90f6718 Mon Sep 17 00:00:00 2001
From: Marli Frost <marli@frost.red>
Date: Wed, 19 Aug 2020 13:33:37 +0100
Subject: [PATCH] docs: elaborate on purpose of crate

---
 src/lib.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/lib.rs b/src/lib.rs
index fdcb8fb5..9bda2fd4 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -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)]