Skip to content

Commit

Permalink
Add basic README.md files to all crates
Browse files Browse the repository at this point in the history
...and configure Cargo.toml(s) to render them on https://crates.io
  • Loading branch information
tarcieri committed May 23, 2020
1 parent de33b2a commit 13341b2
Show file tree
Hide file tree
Showing 13 changed files with 255 additions and 25 deletions.
8 changes: 2 additions & 6 deletions 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]
Expand Down Expand Up @@ -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)
Expand Down
4 changes: 1 addition & 3 deletions block-cipher-trait/Cargo.toml
Expand Up @@ -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"
Expand All @@ -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" ]
49 changes: 49 additions & 0 deletions 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
4 changes: 1 addition & 3 deletions crypto-mac/Cargo.toml
Expand Up @@ -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"
Expand All @@ -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" ]
49 changes: 49 additions & 0 deletions 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
4 changes: 1 addition & 3 deletions digest/Cargo.toml
Expand Up @@ -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"
Expand All @@ -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"]
50 changes: 50 additions & 0 deletions 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
4 changes: 2 additions & 2 deletions signature/README.md
@@ -1,4 +1,4 @@
# RustCrypto: `signature` crate
# RustCrypto: Digital Signature Algorithms

[![crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 0 additions & 2 deletions 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
Expand Down
4 changes: 1 addition & 3 deletions stream-cipher/Cargo.toml
Expand Up @@ -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"
Expand All @@ -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" ]
49 changes: 49 additions & 0 deletions 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
4 changes: 1 addition & 3 deletions universal-hash/Cargo.toml
Expand Up @@ -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]
Expand All @@ -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
49 changes: 49 additions & 0 deletions 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

0 comments on commit 13341b2

Please sign in to comment.