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