Skip to content

Commit

Permalink
Added disclaimer on version compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
user-simon committed Mar 24, 2024
1 parent ea585d8 commit cda99f3
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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::*;
//! ```
Expand Down

0 comments on commit cda99f3

Please sign in to comment.