From 13341b236e6c3edd27faddf7d59012e1ec50fc65 Mon Sep 17 00:00:00 2001 From: Tony Arcieri Date: Sat, 23 May 2020 13:06:54 -0700 Subject: [PATCH] Add basic README.md files to all crates ...and configure Cargo.toml(s) to render them on https://crates.io --- aead/README.md | 8 ++--- block-cipher-trait/Cargo.toml | 4 +-- block-cipher-trait/README.md | 49 +++++++++++++++++++++++++++ crypto-mac/Cargo.toml | 4 +-- crypto-mac/README.md | 49 +++++++++++++++++++++++++++ digest/Cargo.toml | 4 +-- digest/README.md | 50 ++++++++++++++++++++++++++++ signature/README.md | 4 +-- signature/signature_derive/README.md | 2 -- stream-cipher/Cargo.toml | 4 +-- stream-cipher/README.md | 49 +++++++++++++++++++++++++++ universal-hash/Cargo.toml | 4 +-- universal-hash/README.md | 49 +++++++++++++++++++++++++++ 13 files changed, 255 insertions(+), 25 deletions(-) create mode 100644 block-cipher-trait/README.md create mode 100644 crypto-mac/README.md create mode 100644 digest/README.md create mode 100644 stream-cipher/README.md create mode 100644 universal-hash/README.md diff --git a/aead/README.md b/aead/README.md index 78f65cdb..0a95723c 100644 --- a/aead/README.md +++ b/aead/README.md @@ -1,4 +1,4 @@ -# RustCrypto: Authenticated Encryption with Additional Data +# RustCrypto: Authenticated Encryption with Additional Data Traits [![crate][crate-image]][crate-link] [![Docs][docs-image]][docs-link] @@ -27,14 +27,10 @@ done with a minor version bump. - All on-by-default features of this library are covered by SemVer - MSRV is considered exempt from SemVer as noted above -- The off-by-default features `derive-preview` and `digest-preview` are - unstable "preview" features which are also considered exempt from SemVer. - Breaking changes to these features will, like MSRV, be done with a minor - version bump. ## License -All crates licensed under either of +Licensed under either of: * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) * [MIT license](http://opensource.org/licenses/MIT) diff --git a/block-cipher-trait/Cargo.toml b/block-cipher-trait/Cargo.toml index d4fb41e9..7aff4862 100644 --- a/block-cipher-trait/Cargo.toml +++ b/block-cipher-trait/Cargo.toml @@ -4,6 +4,7 @@ description = "Traits for description of block ciphers" version = "0.6.2" authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" +readme = "README.md" edition = "2018" documentation = "https://docs.rs/block-cipher-trait" repository = "https://github.com/RustCrypto/traits" @@ -18,8 +19,5 @@ blobby = { version = "0.1", optional = true } std = [] dev = ["blobby"] -[badges] -travis-ci = { repository = "RustCrypto/traits" } - [package.metadata.docs.rs] features = [ "std" ] diff --git a/block-cipher-trait/README.md b/block-cipher-trait/README.md new file mode 100644 index 00000000..d199536d --- /dev/null +++ b/block-cipher-trait/README.md @@ -0,0 +1,49 @@ +# RustCrypto: Block Cipher Traits + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Build Status][build-image]][build-link] + +Traits which define functionality of block ciphers. + +[Documentation][docs-link] + +## Minimum Supported Rust Version + +Rust **1.41** or higher. + +Minimum supported Rust version can be changed in the future, but it will be +done with a minor version bump. + +## SemVer Policy + +- All on-by-default features of this library are covered by SemVer +- MSRV is considered exempt from SemVer as noted above + +## 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-cipher-trait.svg +[crate-link]: https://crates.io/crates/block-cipher-trait +[docs-image]: https://docs.rs/block-cipher-trait/badge.svg +[docs-link]: https://docs.rs/block-cipher-trait/ +[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 +[build-image]: https://github.com/RustCrypto/traits/workflows/block-cipher-trait/badge.svg?branch=master&event=push +[build-link]: https://github.com/RustCrypto/traits/actions?query=workflow%3Ablock-cipher-trait diff --git a/crypto-mac/Cargo.toml b/crypto-mac/Cargo.toml index 3684784c..06ef469f 100644 --- a/crypto-mac/Cargo.toml +++ b/crypto-mac/Cargo.toml @@ -4,6 +4,7 @@ description = "Trait for Message Authentication Code (MAC) algorithms" version = "0.8.0" authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" +readme = "README.md" edition = "2018" documentation = "https://docs.rs/crypto-mac" repository = "https://github.com/RustCrypto/traits" @@ -19,8 +20,5 @@ blobby = { version = "0.1", optional = true } dev = ["blobby"] std = [] -[badges] -travis-ci = { repository = "RustCrypto/traits" } - [package.metadata.docs.rs] features = [ "std" ] diff --git a/crypto-mac/README.md b/crypto-mac/README.md new file mode 100644 index 00000000..f31ea717 --- /dev/null +++ b/crypto-mac/README.md @@ -0,0 +1,49 @@ +# RustCrypto: Message Authentication Code Traits + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Build Status][build-image]][build-link] + +Traits for Message Authentication Code (MAC) algorithms. + +[Documentation][docs-link] + +## Minimum Supported Rust Version + +Rust **1.41** or higher. + +Minimum supported Rust version can be changed in the future, but it will be +done with a minor version bump. + +## SemVer Policy + +- All on-by-default features of this library are covered by SemVer +- MSRV is considered exempt from SemVer as noted above + +## 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/crypto-mac.svg +[crate-link]: https://crates.io/crates/crypto-mac +[docs-image]: https://docs.rs/crypto-mac/badge.svg +[docs-link]: https://docs.rs/crypto-mac/ +[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 +[build-image]: https://github.com/RustCrypto/traits/workflows/crypto-mac/badge.svg?branch=master&event=push +[build-link]: https://github.com/RustCrypto/traits/actions?query=workflow%3Acrypto-mac diff --git a/digest/Cargo.toml b/digest/Cargo.toml index 3c7229f8..9dffdff5 100644 --- a/digest/Cargo.toml +++ b/digest/Cargo.toml @@ -4,6 +4,7 @@ description = "Traits for cryptographic hash functions" version = "0.8.1" authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" +readme = "README.md" edition = "2018" documentation = "https://docs.rs/digest" repository = "https://github.com/RustCrypto/traits" @@ -18,9 +19,6 @@ blobby = { version = "0.1", optional = true } std = [] dev = ["blobby"] -[badges] -travis-ci = { repository = "RustCrypto/traits" } - [package.metadata.docs.rs] all-features = true rustdoc-args = ["--cfg", "docsrs"] diff --git a/digest/README.md b/digest/README.md new file mode 100644 index 00000000..a3c891e2 --- /dev/null +++ b/digest/README.md @@ -0,0 +1,50 @@ +# RustCrypto: Digest Algorithm Traits + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Build Status][build-image]][build-link] + +Traits which describe functionality of cryptographic hash functions, a.k.a. +digest algorithms. + +[Documentation][docs-link] + +## Minimum Supported Rust Version + +Rust **1.41** or higher. + +Minimum supported Rust version can be changed in the future, but it will be +done with a minor version bump. + +## SemVer Policy + +- All on-by-default features of this library are covered by SemVer +- MSRV is considered exempt from SemVer as noted above + +## 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/digest.svg +[crate-link]: https://crates.io/crates/digest +[docs-image]: https://docs.rs/digest/badge.svg +[docs-link]: https://docs.rs/digest/ +[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 +[build-image]: https://github.com/RustCrypto/traits/workflows/digest/badge.svg?branch=master&event=push +[build-link]: https://github.com/RustCrypto/traits/actions?query=workflow%3Adigest diff --git a/signature/README.md b/signature/README.md index 565b395c..521f8507 100644 --- a/signature/README.md +++ b/signature/README.md @@ -1,4 +1,4 @@ -# RustCrypto: `signature` crate +# RustCrypto: Digital Signature Algorithms [![crate][crate-image]][crate-link] [![Docs][docs-image]][docs-link] @@ -32,7 +32,7 @@ done with a minor version bump. ## License -All crates licensed under either of +Licensed under either of * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) * [MIT license](http://opensource.org/licenses/MIT) diff --git a/signature/signature_derive/README.md b/signature/signature_derive/README.md index 6da6d5d6..e63f6f85 100644 --- a/signature/signature_derive/README.md +++ b/signature/signature_derive/README.md @@ -1,7 +1,5 @@ # `signature` crate custom derive support -[![Build Status](https://travis-ci.org/RustCrypto/traits.svg?branch=master)](https://travis-ci.org/RustCrypto/traits) - This crate provides proc macros used by the `signature` crate. Not intended to be used directly. See the `signature` crate's documentation diff --git a/stream-cipher/Cargo.toml b/stream-cipher/Cargo.toml index eed73432..81061ca3 100644 --- a/stream-cipher/Cargo.toml +++ b/stream-cipher/Cargo.toml @@ -4,6 +4,7 @@ description = "Stream cipher traits" version = "0.3.2" authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" +readme = "README.md" edition = "2018" documentation = "https://docs.rs/stream-cipher" repository = "https://github.com/RustCrypto/traits" @@ -18,8 +19,5 @@ blobby = { version = "0.1", optional = true } std = [] dev = ["blobby"] -[badges] -travis-ci = { repository = "RustCrypto/traits" } - [package.metadata.docs.rs] features = [ "std" ] diff --git a/stream-cipher/README.md b/stream-cipher/README.md new file mode 100644 index 00000000..f49b4c23 --- /dev/null +++ b/stream-cipher/README.md @@ -0,0 +1,49 @@ +# RustCrypto: Stream Cipher Traits + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Build Status][build-image]][build-link] + +Traits which define functionality of stream ciphers. + +[Documentation][docs-link] + +## Minimum Supported Rust Version + +Rust **1.41** or higher. + +Minimum supported Rust version can be changed in the future, but it will be +done with a minor version bump. + +## SemVer Policy + +- All on-by-default features of this library are covered by SemVer +- MSRV is considered exempt from SemVer as noted above + +## 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/stream-cipher.svg +[crate-link]: https://crates.io/crates/stream-cipher +[docs-image]: https://docs.rs/stream-cipher/badge.svg +[docs-link]: https://docs.rs/stream-cipher/ +[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 +[build-image]: https://github.com/RustCrypto/traits/workflows/stream-cipher/badge.svg?branch=master&event=push +[build-link]: https://github.com/RustCrypto/traits/actions?query=workflow%3Astream-cipher diff --git a/universal-hash/Cargo.toml b/universal-hash/Cargo.toml index 66da4570..78d80349 100644 --- a/universal-hash/Cargo.toml +++ b/universal-hash/Cargo.toml @@ -8,6 +8,7 @@ documentation = "https://docs.rs/universal-hash" repository = "https://github.com/RustCrypto/traits" keywords = ["crypto", "mac"] categories = ["cryptography", "no-std"] +readme = "README.md" edition = "2018" [dependencies] @@ -17,8 +18,5 @@ subtle = { version = "2", default-features = false } [features] std = [] -[badges] -travis-ci = { repository = "RustCrypto/traits" } - [package.metadata.docs.rs] all-features = true diff --git a/universal-hash/README.md b/universal-hash/README.md new file mode 100644 index 00000000..ac238bab --- /dev/null +++ b/universal-hash/README.md @@ -0,0 +1,49 @@ +# RustCrypto: Universal Hash Function Traits + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Build Status][build-image]][build-link] + +Traits which define functionality of universal hash functions. + +[Documentation][docs-link] + +## Minimum Supported Rust Version + +Rust **1.41** or higher. + +Minimum supported Rust version can be changed in the future, but it will be +done with a minor version bump. + +## SemVer Policy + +- All on-by-default features of this library are covered by SemVer +- MSRV is considered exempt from SemVer as noted above + +## 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/universal-hash.svg +[crate-link]: https://crates.io/crates/universal-hash +[docs-image]: https://docs.rs/universal-hash/badge.svg +[docs-link]: https://docs.rs/universal-hash/ +[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 +[build-image]: https://github.com/RustCrypto/traits/workflows/universal-hash/badge.svg?branch=master&event=push +[build-link]: https://github.com/RustCrypto/traits/actions?query=workflow%3Auniversal-hash