Skip to content

Commit

Permalink
improve description of feature gates in readme document
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysd committed Aug 12, 2024
1 parent d4342dc commit b849170
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,16 +149,16 @@ ratatui = "*"
tui-textarea = "*"
```

If you need text search with regular expressions, enable `search` feature. It adds [regex crate][regex] crate as
dependency.
If you need text search with regular expressions, enable `search` feature. It adds [regex crate][regex] as dependency.

```toml
[dependencies]
ratatui = "*"
tui-textarea = { version = "*", features = ["search"] }
```

If you're using ratatui with [termion][] or [termwiz][], enable respective feature instead of `crossterm` feature.
If you're using ratatui with [termion][] or [termwiz][], enable the `termion` or `termwiz` feature instead of
`crossterm` feature.

```toml
[dependencies]
Expand Down Expand Up @@ -192,9 +192,10 @@ Note that [ratatui][] support and [tui-rs][] support are exclusive. When you use
[ratatui][] support by `default-features = false`.

In addition to above dependencies, you also need to install [crossterm][] or [termion][] or [termwiz][] to initialize
your application and to receive key inputs. Note that version of [crossterm][] crate and [termion][] crate are different
between [ratatui][] and [tui-rs][]. Please select the same dependency version. For example, [tui-rs][] depends on
[crossterm][] v0.2.5 or [termion][] v1.5 where both crates are older than [ratatui][]'s dependencies.
your application and to receive key inputs. Note that the dependency versions of [crossterm][] crate and [termion][]
crate differ between [ratatui][] and [tui-rs][]. Please make sure to use the same version that matches the package you
are using. For example, [tui-rs][] depends on [crossterm][] v0.2.5 or [termion][] v1.5 where both crates are older than
[ratatui][]'s dependencies.

## Minimal Usage

Expand Down

0 comments on commit b849170

Please sign in to comment.