Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
algesten committed Dec 3, 2024
1 parent af2143b commit dfab260
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,20 @@

A simple, safe HTTP client.

> [!NOTE]
> * 2.12.x is MSRV 1.71
> * 2.11.x is MSRV 1.67
>
> For both these lines, we will release patch version pinning dependencies as needed to
> retain the MSRV. If we are bumping MSRV, that will require a minor version bump.
> [!NOTE]
> ureq version 2.11.0 was forced to bump MSRV from 1.63 -> 1.67. The problem is that the
> `time` crate 0.3.20, the last 1.63 compatible version, stopped compiling with Rust
> [1.80 and above](https://github.com/algesten/ureq/pull/878#issuecomment-2503176155).
> To release a 2.x version that is possible to compile on the latest Rust we were
> forced to bump MSRV.


Ureq's first priority is being easy for you to use. It's great for
anyone who wants a low-overhead HTTP client that just gets the job done. Works
very well with HTTP APIs. Its features include cookies, JSON, HTTP proxies,
Expand Down
9 changes: 7 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,19 @@
//! A simple, safe HTTP client.
//!
//! > [!NOTE]
//! > * 2.12.x is MSRV 1.71
//! > * 2.11.x is MSRV 1.67
//! >
//! > For both these lines, we will release patch version pinning dependencies as needed to
//! > retain the MSRV. If we are bumping MSRV, that will require a minor version bump.
//!
//! > [!NOTE]
//! > ureq version 2.11.0 was forced to bump MSRV from 1.63 -> 1.67. The problem is that the
//! > `time` crate 0.3.20, the last 1.63 compatible version, stopped compiling with Rust
//! > [1.80 and above](https://github.com/algesten/ureq/pull/878#issuecomment-2503176155).
//! > To release a 2.x version that is possible to compile on the latest Rust we were
//! > forced to bump MSRV.
//!
//!
//!
//! Ureq's first priority is being easy for you to use. It's great for
//! anyone who wants a low-overhead HTTP client that just gets the job done. Works
//! very well with HTTP APIs. Its features include cookies, JSON, HTTP proxies,
Expand Down

0 comments on commit dfab260

Please sign in to comment.