Skip to content

Commit fb3bbbe

Browse files
committed
update readme
1 parent 16fd842 commit fb3bbbe

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
# RustCrypto: Password Hashes [![Project Chat][chat-image]][chat-link] [![dependency status][deps-image]][deps-link]
1+
# RustCrypto: Password Hashes
2+
3+
[![Project Chat][chat-image]][chat-link] [![dependency status][deps-image]][deps-link] ![Apache2/MIT licensed][license-image]
24

35
Collection of password hashing algorithms, otherwise known as password-based key derivation functions, written in pure Rust.
46

57
## Supported Algorithms
68

79
| Algorithm | Crate | Crates.io | Documentation | MSRV |
810
|-----------|-------|:----------:|:-------------:|:----:|
9-
| [Argon2] | `argon2` | [![crates.io](https://img.shields.io/crates/v/argon2.svg)](https://crates.io/crates/argon2) | [![Documentation](https://docs.rs/argon2/badge.svg)](https://docs.rs/argon2) | ![MSRV 1.51][msrv-1.51] |
10-
| [bcrypt-pbkdf] | `bcrypt-pbkdf` |[![crates.io](https://img.shields.io/crates/v/bcrypt-pbkdf.svg)](https://crates.io/crates/bcrypt-pbkdf) | [![Documentation](https://docs.rs/bcrypt-pbkdf/badge.svg)](https://docs.rs/bcrypt-pbkdf) | ![MSRV 1.51][msrv-1.51] |
11-
| [PBKDF2] | `pbkdf2` | [![crates.io](https://img.shields.io/crates/v/pbkdf2.svg)](https://crates.io/crates/pbkdf2) | [![Documentation](https://docs.rs/pbkdf2/badge.svg)](https://docs.rs/pbkdf2) | ![MSRV 1.51][msrv-1.51] |
12-
| [scrypt] | `scrypt` | [![crates.io](https://img.shields.io/crates/v/scrypt.svg)](https://crates.io/crates/scrypt) | [![Documentation](https://docs.rs/scrypt/badge.svg)](https://docs.rs/scrypt) | ![MSRV 1.51][msrv-1.51] |
13-
| [SHA-crypt] | `sha-crypt` | [![crates.io](https://img.shields.io/crates/v/sha-crypt.svg)](https://crates.io/crates/sha-crypt) | [![Documentation](https://docs.rs/sha-crypt/badge.svg)](https://docs.rs/sha-crypt) | ![MSRV 1.51][msrv-1.51] |
11+
| [Argon2] | [`argon2`] | [![crates.io](https://img.shields.io/crates/v/argon2.svg)](https://crates.io/crates/argon2) | [![Documentation](https://docs.rs/argon2/badge.svg)](https://docs.rs/argon2) | ![MSRV 1.51][msrv-1.51] |
12+
| [bcrypt-pbkdf] | [`bcrypt-pbkdf`] |[![crates.io](https://img.shields.io/crates/v/bcrypt-pbkdf.svg)](https://crates.io/crates/bcrypt-pbkdf) | [![Documentation](https://docs.rs/bcrypt-pbkdf/badge.svg)](https://docs.rs/bcrypt-pbkdf) | ![MSRV 1.51][msrv-1.51] |
13+
| [PBKDF2] | [`pbkdf2`] | [![crates.io](https://img.shields.io/crates/v/pbkdf2.svg)](https://crates.io/crates/pbkdf2) | [![Documentation](https://docs.rs/pbkdf2/badge.svg)](https://docs.rs/pbkdf2) | ![MSRV 1.51][msrv-1.51] |
14+
| [scrypt] | [`scrypt`] | [![crates.io](https://img.shields.io/crates/v/scrypt.svg)](https://crates.io/crates/scrypt) | [![Documentation](https://docs.rs/scrypt/badge.svg)](https://docs.rs/scrypt) | ![MSRV 1.51][msrv-1.51] |
15+
| [SHA-crypt] | [`sha-crypt`] | [![crates.io](https://img.shields.io/crates/v/sha-crypt.svg)](https://crates.io/crates/sha-crypt) | [![Documentation](https://docs.rs/sha-crypt/badge.svg)](https://docs.rs/sha-crypt) | ![MSRV 1.51][msrv-1.51] |
1416

1517
Please see the [OWASP Password Storage Cheat Sheet] for assistance in selecting an appropriate algorithm for your use case.
1618

@@ -35,10 +37,19 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
3537

3638
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
3739
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260046-password-hashes
40+
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
3841
[deps-image]: https://deps.rs/repo/github/RustCrypto/password-hashes/status.svg
3942
[deps-link]: https://deps.rs/repo/github/RustCrypto/password-hashes
4043
[msrv-1.51]: https://img.shields.io/badge/rustc-1.51.0+-blue.svg
4144

45+
[//]: # (crates)
46+
47+
[`argon2`]: ./argon2
48+
[`bcrypt-pbkdf`]: ./bcrypt-pbkdf
49+
[`pbkdf2`]: ./pbkdf2
50+
[`scrypt`]: ./scrypt
51+
[`sha-crypt`]: ./sha-crypt
52+
4253
[//]: # (general links)
4354

4455
[Argon2]: https://en.wikipedia.org/wiki/Argon2

0 commit comments

Comments
 (0)