1zip-rs
2======
3
4[![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)
5[![Crates.io version](https://img.shields.io/crates/v/zip.svg)](https://crates.io/crates/zip)
6
7[Documentation](https://docs.rs/zip/0.5.10/zip/)
8
9
10Info
11----
12
13A zip library for rust which supports reading and writing of simple ZIP files.
14
15Supported compression formats:
16
17* stored (i.e. none)
18* deflate
19* bzip2
20
21Currently unsupported zip extensions:
22
23* Encryption
24* Multi-disk
25
26Usage
27-----
28
29With all default features:
30
31```toml
32[dependencies]
33zip = "0.5"
34```
35
36Without the default features:
37
38```toml
39[dependencies]
40zip = { version = "0.5", default-features = false }
41```
42
43The features available are:
44
45* `deflate`: Enables the deflate compression algorithm, which is the default for zipfiles
46* `bzip2`: Enables the BZip2 compression algorithm.
47* `time`: Enables features using the [time](https://github.com/rust-lang-deprecated/time) crate.
48
49All of these are enabled by default.
50
51MSRV
52----
53
54Our current Minimum Supported Rust Version is **1.34.0**. When adding features,
55we will follow these guidelines:
56
57- We will always support the latest four minor Rust versions. This gives you a 6
58  month window to upgrade your compiler.
59- Any change to the MSRV will be accompanied with a **minor** version bump
60   - While the crate is pre-1.0, this will be a change to the PATCH version.
61
62Examples
63--------
64
65See the [examples directory](examples) for:
66   * How to write a file to a zip.
67   * How to write a directory of files to a zip (using [walkdir](https://github.com/BurntSushi/walkdir)).
68   * How to extract a zip file.
69   * How to extract a single file from a zip.
70   * How to read a zip from the standard input.
71