From cda99f361e76a42f8c297b8c053563d398c19f16 Mon Sep 17 00:00:00 2001 From: Simon Date: Sun, 24 Mar 2024 18:41:22 +0100 Subject: [PATCH] Added disclaimer on version compatibility --- src/lib.rs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index a38daf0..34ae26e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -22,12 +22,14 @@ //! //! # Getting Started //! -//! Add Tundra and Ratatui to the project dependencies: +//! Add Tundra and Ratatui to the project dependencies, and note that the version of Ratatui used must be +//! [compatible](https://doc.rust-lang.org/cargo/reference/resolver.html#semver-compatibility) with the one +//! used by Tundra: //! ```text -//! $ cargo add tundra ratatui +//! $ cargo add tundra ratatui@0.26 //! ``` //! -//! Import the [Tundra prelude](prelude), exposing symbols required in virtually all applications: +//! Next, import the [Tundra prelude](prelude), exposing symbols required in virtually all applications: //! ```no_run //! use tundra::prelude::*; //! ```