vendor/adler/README.md

   1 # Adler-32 checksums for Rust
   2
   3 [![crates.io](https://img.shields.io/crates/v/adler.svg)](https://crates.io/crates/adler)
   4 [![docs.rs](https://docs.rs/adler/badge.svg)](https://docs.rs/adler/)
   5 ![CI](https://github.com/jonas-schievink/adler/workflows/CI/badge.svg)
   6
   7 This crate provides a simple implementation of the Adler-32 checksum, used in
   8 the zlib compression format.
   9
  10 Please refer to the [changelog](CHANGELOG.md) to see what changed in the last
  11 releases.
  12
  13 ## Features
  14
  15 - Permissively licensed (0BSD) clean-room implementation.
  16 - Zero dependencies.
  17 - Zero `unsafe`.
  18 - Decent performance (3-4 GB/s).
  19 - Supports `#![no_std]` (with `default-features = false`).
  20
  21 ## Usage
  22
  23 Add an entry to your `Cargo.toml`:
  24
  25 ```toml
  26 [dependencies]
  27 adler = "1.0.2"
  28 ```
  29
  30 Check the [API Documentation](https://docs.rs/adler/) for how to use the
  31 crate's functionality.
  32
  33 ## Rust version support
  34
  35 Currently, this crate supports all Rust versions starting at Rust 1.31.0.
  36
  37 Bumping the Minimum Supported Rust Version (MSRV) is *not* considered a breaking
  38 change, but will not be done without good reasons. The latest 3 stable Rust
  39 versions will always be supported no matter what.