add readme

Author: newpavlov

block-buffer/Cargo.toml

@@ -3,12 +3,13 @@ name = "block-buffer"
 version = "0.10.0" # Also update html_root_url in lib.rs when bumping this
 authors = ["RustCrypto Developers"]
 license = "MIT OR Apache-2.0"
-description = "Fixed size buffer for block processing of data"
+description = "Buffer type for block processing of data"
 documentation = "https://docs.rs/block-buffer"
 repository = "https://github.com/RustCrypto/utils"
 keywords = ["block", "buffer"]
 categories = ["cryptography", "no-std"]
 edition = "2018"
+readme = "README.md"
 
 [dependencies]
 generic-array = "0.14"

block-buffer/README.md

@@ -0,0 +1,40 @@
+# [RustCrypto]: Block Buffer
+
+[![crate][crate-image]][crate-link]
+[![Docs][docs-image]][docs-link]
+![Apache2/MIT licensed][license-image]
+![Rust Version][rustc-image]
+[![Project Chat][chat-image]][chat-link]
+[![Build Status][build-image]][build-link]
+
+Buffer type for block processing of data with minimized amount of unreachable panics.
+
+## License
+
+Licensed under either of:
+
+ * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+ * [MIT license](http://opensource.org/licenses/MIT)
+
+at your option.
+
+### 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)
+
+[crate-image]: https://img.shields.io/crates/v/block-buffer.svg
+[crate-link]: https://crates.io/crates/block-buffer
+[docs-image]: https://docs.rs/block-buffer/badge.svg
+[docs-link]: https://docs.rs/block-buffer/
+[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.41+-blue.svg
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
+[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260052-utils
+[build-image]: https://github.com/RustCrypto/utils/workflows/block-buffer/badge.svg?branch=master&event=push
+[build-link]: https://github.com/RustCrypto/utils/actions/workflows/block-buffer.yml
+
+[//]: # (general links)
+
+[RustCrypto]: https://github.com/rustcrypto