Skip to content

Commit dddc078

Browse files
committed
Added README--still some broken links
1 parent d787b9a commit dddc078

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

fsb/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ categories = ["cryptography", "no-std"]
1414
whirlpool = "0.9"
1515
digest = "0.9"
1616
block-buffer = { version = "0.9", features = ["block-padding"] }
17+
opaque-debug = "0.3"
1718

1819
[dev-dependencies]
1920
hex-literal = "0.3.1"

fsb/README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# RustCrypto: FSB
2+
3+
<!---
4+
[![crate][crate-image]][crate-link]
5+
[![Docs][docs-image]][docs-link]
6+
[![Build Status][build-image]][build-link]
7+
-->
8+
![Apache2/MIT licensed][license-image]
9+
![Rust Version][rustc-image]
10+
[![Project Chat][chat-image]][chat-link]
11+
12+
Pure Rust implementation of the [FSB hash function][1] family.
13+
14+
[Documentation][docs-link]
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/fsb.svg
46+
[crate-link]: https://crates.io/crates/fsb
47+
[docs-image]: https://docs.rs/fsb/badge.svg
48+
[docs-link]: https://docs.rs/fsb/
49+
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
50+
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
51+
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260041-hashes
52+
[rustc-image]: https://img.shields.io/badge/rustc-1.41+-blue.svg
53+
[build-image]: https://github.com/RustCrypto/hashes/workflows/fsb/badge.svg?branch=master
54+
[build-link]: https://github.com/RustCrypto/hashes/actions?query=workflow%3Afsb
55+
56+
[//]: # (general links)
57+
58+
[1]: https://www.paris.inria.fr/secret/CBCrypto/index.php?pg=fsb

0 commit comments

Comments
 (0)