This repository has been archived by the owner on Jun 2, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 204
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #447 from Pr0methean/patch-1
Update README.md to state that the crate has moved
- Loading branch information
Showing
1 changed file
with
3 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,4 @@ | ||
| zip-rs | ||
| ====== | ||
| zip has moved | ||
| ============= | ||
|
|
||
| [](https://github.com/zip-rs/zip/actions?query=branch%3Amaster+workflow%3ACI) | ||
| [](https://crates.io/crates/zip) | ||
| [](https://discord.gg/rQ7H9cSsF4) | ||
|
|
||
| [Documentation](https://docs.rs/zip/0.6.3/zip/) | ||
|
|
||
| Info | ||
| ---- | ||
|
|
||
|
|
||
| A zip library for rust which supports reading and writing of simple ZIP files. | ||
|
|
||
| Supported compression formats: | ||
|
|
||
| * stored (i.e. none) | ||
| * deflate | ||
| * bzip2 | ||
| * zstd | ||
|
|
||
| Currently unsupported zip extensions: | ||
|
|
||
| * Encryption | ||
| * Multi-disk | ||
|
|
||
| Usage | ||
| ----- | ||
|
|
||
| With all default features: | ||
|
|
||
| ```toml | ||
| [dependencies] | ||
| zip = "0.6" | ||
| ``` | ||
|
|
||
| Without the default features: | ||
|
|
||
| ```toml | ||
| [dependencies] | ||
| zip = { version = "0.6.6", default-features = false } | ||
| ``` | ||
|
|
||
| The features available are: | ||
|
|
||
| * `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.59.0**. When adding features, | ||
| we will follow these guidelines: | ||
|
|
||
| - We will always support the latest four minor Rust versions. This gives you a 6 | ||
| month window to upgrade your compiler. | ||
| - Any change to the MSRV will be accompanied with a **minor** version bump | ||
| - While the crate is pre-1.0, this will be a change to the PATCH version. | ||
|
|
||
| Examples | ||
| -------- | ||
|
|
||
| See the [examples directory](examples) for: | ||
| * How to write a file to a zip. | ||
| * How to write a directory of files to a zip (using [walkdir](https://github.com/BurntSushi/walkdir)). | ||
| * How to extract a zip file. | ||
| * How to extract a single file from a zip. | ||
| * How to read a zip from the standard input. | ||
|
|
||
| Fuzzing | ||
| ------- | ||
|
|
||
| Fuzzing support is through [cargo fuzz](https://github.com/rust-fuzz/cargo-fuzz). To install cargo fuzz: | ||
|
|
||
| ```bash | ||
| cargo install cargo-fuzz | ||
| ``` | ||
|
|
||
| To list fuzz targets: | ||
|
|
||
| ```bash | ||
| cargo +nightly fuzz list | ||
| ``` | ||
|
|
||
| To start fuzzing zip extraction: | ||
|
|
||
| ```bash | ||
| cargo +nightly fuzz run fuzz_read | ||
| ``` | ||
| This repository was formerly the source of the [zip](https://crates.io/crates/zip) Rust crate for compressing and decompressing ZIP files, but that has moved to https://github.com/Pr0methean/zip. Please submit all issues and pull requests there, and close any existing copies here. Once the existing ones are closed, this repository will be archived. |