Skip to content

Commit 41c5042

Browse files
authored
RUST-1477 Add 1.x EOL notice (#773)
1 parent 084f9a2 commit 41c5042

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ For more detailed documentation, see [the manual](https://mongodb.github.io/mong
88
## Index
99
- [Installation](#installation)
1010
- [Requirements](#requirements)
11+
- [Supported platforms](#supported-platforms)
1112
- [Importing](#importing)
1213
- [Configuring the async runtime](#configuring-the-async-runtime)
1314
- [Enabling the sync API](#enabling-the-sync-api)
@@ -20,28 +21,34 @@ For more detailed documentation, see [the manual](https://mongodb.github.io/mong
2021
- [Finding documents in a collection](#finding-documents-in-a-collection)
2122
- [Using the sync API](#using-the-sync-api)
2223
- [Web Framework Examples](#web-framework-examples)
23-
- [Platforms](#platforms)
2424
- [Note on connecting to Atlas deployments](#note-on-connecting-to-atlas-deployments)
2525
- [Windows DNS note](#windows-dns-note)
2626
- [Warning about timeouts / cancellation](#warning-about-timeouts--cancellation)
2727
- [Bug Reporting / Feature Requests](#bug-reporting--feature-requests)
2828
- [Contributing](#contributing)
2929
- [Running the tests](#running-the-tests)
3030
- [Continuous Integration](#continuous-integration)
31+
- [Minimum supported Rust version (MSRV) policy](#minimum-supported-rust-version-msrv-policy)
3132
- [License](#license)
3233

3334
## Installation
3435
### Requirements
35-
- Rust 1.57+
36+
- Rust 1.57+ (See the [MSRV policy](#minimum-supported-rust-version-msrv-policy) for more information)
3637
- MongoDB 3.6+
3738

39+
#### Supported Platforms
40+
41+
The driver tests against Linux, MacOS, and Windows in CI.
42+
3843
### Importing
3944
The driver is available on [crates.io](https://crates.io/crates/mongodb). To use the driver in your application, simply add it to your project's `Cargo.toml`.
4045
```toml
4146
[dependencies]
4247
mongodb = "2.3.0"
4348
```
4449

50+
Version 1 of this crate has reached end of life and will no longer be receiving any updates or bug fixes, so all users are recommended to always depend on the latest 2.x release. See the [2.0.0 release notes](https://github.com/mongodb/mongo-rust-driver/releases/tag/v2.0.0) for migration information if upgrading from a 1.x version.
51+
4552
#### Configuring the async runtime
4653
The driver supports both of the most popular async runtime crates, namely [`tokio`](https://crates.io/crates/tokio) and [`async-std`](https://crates.io/crates/async-std). By default, the driver will use [`tokio`](https://crates.io/crates/tokio), but you can explicitly choose a runtime by specifying one of `"tokio-runtime"` or `"async-std-runtime"` feature flags in your `Cargo.toml`.
4754

@@ -244,10 +251,6 @@ The driver can be used easily with the Actix web framework by storing a `Client`
244251
### Rocket
245252
The Rocket web framework provides built-in support for MongoDB via the Rust driver. The documentation for the [`rocket_db_pools`](https://api.rocket.rs/v0.5-rc/rocket_db_pools/index.html) crate contains instructions for using MongoDB with your Rocket application.
246253

247-
## Platforms
248-
249-
The driver tests against Linux, MacOS, and Windows in CI.
250-
251254
## Note on connecting to Atlas deployments
252255

253256
In order to connect to a pre-4.2 Atlas instance that's M2 or bigger, the `openssl-tls` feature flag must be enabled. The flag is not required for clusters smaller than M2 or running server versions 4.2 or newer.
@@ -367,7 +370,7 @@ bash .evergreen/check-all.sh
367370
## Continuous Integration
368371
Commits to main are run automatically on [evergreen](https://evergreen.mongodb.com/waterfall/mongo-rust-driver).
369372

370-
## Minimum supported Rust version (MSRV)
373+
## Minimum supported Rust version (MSRV) policy
371374

372375
The MSRV for this crate is currently 1.57.0. This will rarely be increased, and if it ever is,
373376
it will only happen in a minor or major version release.

0 commit comments

Comments
 (0)