aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid LeGare <legare@google.com>2022-04-11 16:44:12 +0000
committerDavid LeGare <legare@google.com>2022-04-13 19:21:47 +0000
commit132eccb8457b0bcf913edee0173b91821599a064 (patch)
tree5488828d7446ad70a03375c5837022ef5b4e32e4 /README.md
parent2095b106a168c52e7e17543d3aef87545666aa4e (diff)
downloadzip-132eccb8457b0bcf913edee0173b91821599a064.tar.gz
Upgrade rust/crates/zip to 0.6.2
Test: make Change-Id: I7548909fd3b2779be25a3aa7cdffcae3faa856a5
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index e489b98..7db31d4 100644
--- a/README.md
+++ b/README.md
@@ -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