Skip to content

Commit

Permalink
README.md: add boilerplate (#22)
Browse files Browse the repository at this point in the history
Adds README.md boilerplate used in other repos
  • Loading branch information
tarcieri authored Oct 20, 2020
1 parent 6f12000 commit 224ecbe
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
# RustCrypto: ASM hashes [![Project Chat][chat-image]][chat-link]

Assembly implementations of hash functions core functionality based on code from
[Project Nayuki](https://www.nayuki.io/).

Crates in this repository provide only core compression functions, for full hash
functionality please refer to the crates from
[RustCrypto/hashes](https://github.com/RustCrypto/hashes) repository. With
enabled `asm` feature `md5`, `sha-1`, `sha2` and `whirlpool` crates will use
code from this repository.
code from this repository.

## License

All crates licensed under the [MIT license](http://opensource.org/licenses/MIT).

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

[//]: # (badges)

[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260041-hashes

0 comments on commit 224ecbe

Please sign in to comment.