diff --git a/Cargo.lock b/Cargo.lock index 67a1acd9..fe2fcf92 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -101,7 +101,7 @@ dependencies = [ [[package]] name = "inout" -version = "0.2.0-pre" +version = "0.2.0-pre.1" dependencies = [ "block-padding", "hybrid-array 0.2.0-pre.6 (registry+https://github.com/rust-lang/crates.io-index)", diff --git a/inout/Cargo.toml b/inout/Cargo.toml index 6c97a544..27872d69 100644 --- a/inout/Cargo.toml +++ b/inout/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "inout" -version = "0.2.0-pre" +version = "0.2.0-pre.1" description = "Custom reference types for code generic over in-place and buffer-to-buffer modes of operation." authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" @@ -9,6 +9,7 @@ rust-version = "1.56" documentation = "https://docs.rs/inout" repository = "https://github.com/RustCrypto/utils" keywords = ["custom-reference"] +readme = "README.md" [dependencies] block-padding = { version = "=0.4.0-pre.1", path = "../block-padding", optional = true } diff --git a/inout/README.md b/inout/README.md new file mode 100644 index 00000000..e4b9d75c --- /dev/null +++ b/inout/README.md @@ -0,0 +1,40 @@ +# [RustCrypto]: Input/Output Reference Types + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Build Status][build-image]][build-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Project Chat][chat-image]][chat-link] + +Custom reference types for code generic over in-place and buffer-to-buffer modes of operation. + +## 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/inout.svg +[crate-link]: https://crates.io/crates/inout +[docs-image]: https://docs.rs/inout/badge.svg +[docs-link]: https://docs.rs/inout/ +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.65+-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/inout/badge.svg?branch=master&event=push +[build-link]: https://github.com/RustCrypto/utils/actions/workflows/inout.yml + +[//]: # (general links) + +[RustCrypto]: https://github.com/rustcrypto