Skip to content

Commit

Permalink
docs: update readme of crates with MSRV text (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
simonsan authored Sep 25, 2024
1 parent b9cbe28 commit b8836f3
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 4 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,18 @@ This crate has the following features:
modules that require the standard library. If this feature is not set, `merge`
is a `no_std` library.

## Minimum Supported Rust Version
## Minimum Rust version policy

This crate supports Rust 1.64.0 or later.
This crate's minimum supported `rustc` version is `1.64.0`.

The current policy is that the minimum Rust version required to use this crate
can be increased in minor version updates. For example, if `crate 1.0` requires
Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust
1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum
version of Rust.

In general, this crate will be conservative with respect to the minimum
supported version of Rust.

## Contact

Expand Down
13 changes: 11 additions & 2 deletions crates/merge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,18 @@ This crate has the following features:
modules that require the standard library. If this feature is not set, `merge`
is a `no_std` library.

## Minimum Supported Rust Version
## Minimum Rust version policy

This crate supports Rust 1.36.0 or later.
This crate's minimum supported `rustc` version is `1.64.0`.

The current policy is that the minimum Rust version required to use this crate
can be increased in minor version updates. For example, if `crate 1.0` requires
Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust
1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum
version of Rust.

In general, this crate will be conservative with respect to the minimum
supported version of Rust.

## Contact

Expand Down
13 changes: 13 additions & 0 deletions crates/merge_derive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,17 @@ SPDX-License-Identifier: CC0-1.0
This crate provides a derive macro for the `merge::Merge` crate. See the
[`merge`][`merge`] crate for more information.

## Minimum Rust version policy

This crate's minimum supported `rustc` version is `1.64.0`.

The current policy is that the minimum Rust version required to use this crate
can be increased in minor version updates. For example, if `crate 1.0` requires
Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust
1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum
version of Rust.

In general, this crate will be conservative with respect to the minimum
supported version of Rust.

[`merge`]: https://lib.rs/crates/merge

0 comments on commit b8836f3

Please sign in to comment.