vendor/sha2/README.md

   1 # RustCrypto: SHA-2
   2
   3 [![crate][crate-image]][crate-link]
   4 [![Docs][docs-image]][docs-link]
   5 ![Apache2/MIT licensed][license-image]
   6 ![Rust Version][rustc-image]
   7 [![Build Status][build-image]][build-link]
   8
   9 Pure Rust implementation of the [SHA-2 hash function family][1]
  10 including SHA-224, SHA-256, SHA-384, and SHA-512.
  11
  12 [Documentation][docs-link]
  13
  14 <img src="https://raw.githubusercontent.com/RustCrypto/meta/master/img/hashes/sha2.png" width="480px">
  15
  16 ## Minimum Supported Rust Version
  17
  18 Rust **1.41** or higher.
  19
  20 Minimum supported Rust version can be changed in the future, but it will be
  21 done with a minor version bump.
  22
  23 ## SemVer Policy
  24
  25 - All on-by-default features of this library are covered by SemVer
  26 - MSRV is considered exempt from SemVer as noted above
  27
  28 ## License
  29
  30 Licensed under either of:
  31
  32  * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
  33  * [MIT license](http://opensource.org/licenses/MIT)
  34
  35 at your option.
  36
  37 ### Contribution
  38
  39 Unless you explicitly state otherwise, any contribution intentionally submitted
  40 for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
  41 dual licensed as above, without any additional terms or conditions.
  42
  43 [//]: # (badges)
  44
  45 [crate-image]: https://img.shields.io/crates/v/sha2.svg
  46 [crate-link]: https://crates.io/crates/sha2
  47 [docs-image]: https://docs.rs/sha2/badge.svg
  48 [docs-link]: https://docs.rs/sha2/
  49 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
  50 [rustc-image]: https://img.shields.io/badge/rustc-1.41+-blue.svg
  51 [build-image]: https://github.com/RustCrypto/hashes/workflows/sha2/badge.svg?branch=master
  52 [build-link]: https://github.com/RustCrypto/hashes/actions?query=workflow%3Asha2
  53
  54 [//]: # (general links)
  55
  56 [1]: https://en.wikipedia.org/wiki/SHA-2