diff --git a/README.md b/README.md index dbc0bb2..e7c9748 100644 --- a/README.md +++ b/README.md @@ -21,4 +21,23 @@ But that's not all it does. That's just what that one comment says. Some other f - The end central directory entry is found by scanning from the end of the file, rather than from the beginning. - The central directory values are authoritative. Names/values defined by the local file headers are ignored. - The file data of local file headers is not size bound by the file header's compressed size field. Instead, it uses the central directory header's declared size. -- Class names are allowed to end in trailing `/` which most tools interpret as directories. \ No newline at end of file +- Class names are allowed to end in trailing `/` which most tools interpret as directories. + +## Usage + +Maven dependency: +```xml + + software.coley + lljzip + ${zipVersion} + +``` + +Gradle dependency: +```groovy +implementation group: 'software.coley', name: 'lljzip', version: zipVersion +implementation "software.coley:lljzip:${zipVersion}" +``` + +For example usage see the [tests](src/test/java/software/coley/llzip). \ No newline at end of file