diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 12 insertions, 5 deletions
@@ -3,13 +3,17 @@ zip-rs [![Build Status](https://img.shields.io/github/workflow/status/zip-rs/zip/CI)](https://github.com/zip-rs/zip/actions?query=branch%3Amaster+workflow%3ACI) [![Crates.io version](https://img.shields.io/crates/v/zip.svg)](https://crates.io/crates/zip) +[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/rQ7H9cSsF4) -[Documentation](https://docs.rs/zip/0.5.13/zip/) +[Documentation](https://docs.rs/zip/0.6.2/zip/) +> PSA: This version of the ZIP crate will not gain any new features, +> and will only be updated if major security issues are found. Info ---- + A zip library for rust which supports reading and writing of simple ZIP files. Supported compression formats: @@ -17,6 +21,7 @@ Supported compression formats: * stored (i.e. none) * deflate * bzip2 +* zstd Currently unsupported zip extensions: @@ -30,28 +35,30 @@ With all default features: ```toml [dependencies] -zip = "0.5" +zip = "0.6.2" ``` Without the default features: ```toml [dependencies] -zip = { version = "0.5", default-features = false } +zip = { version = "0.6.2", default-features = false } ``` The features available are: -* `deflate`: Enables the deflate compression algorithm, which is the default for zipfiles +* `aes-crypto`: Enables decryption of files which were encrypted with AES. Supports AE-1 and AE-2 methods. +* `deflate`: Enables the deflate compression algorithm, which is the default for zip files. * `bzip2`: Enables the BZip2 compression algorithm. * `time`: Enables features using the [time](https://github.com/rust-lang-deprecated/time) crate. +* `zstd`: Enables the Zstandard compression algorithm. All of these are enabled by default. MSRV ---- -Our current Minimum Supported Rust Version is **1.36.0**. When adding features, +Our current Minimum Supported Rust Version is **1.54.0**. When adding features, we will follow these guidelines: - We will always support the latest four minor Rust versions. This gives you a 6 |