1
0
зеркало из https://github.com/glebtv/tui-textarea.git synced 2026-09-07 16:05:50 +03:00

improve description of feature gates in readme document

Этот коммит содержится в:
rhysd
2024-08-12 22:29:08 +09:00
родитель d4342dceef
Коммит b8491704bc

Просмотреть файл

@@ -149,8 +149,7 @@ ratatui = "*"
tui-textarea = "*" tui-textarea = "*"
``` ```
If you need text search with regular expressions, enable `search` feature. It adds [regex crate][regex] crate as If you need text search with regular expressions, enable `search` feature. It adds [regex crate][regex] as dependency.
dependency.
```toml ```toml
[dependencies] [dependencies]
@@ -158,7 +157,8 @@ ratatui = "*"
tui-textarea = { version = "*", features = ["search"] } 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 ```toml
[dependencies] [dependencies]
@@ -192,9 +192,10 @@ Note that [ratatui][] support and [tui-rs][] support are exclusive. When you use
[ratatui][] support by `default-features = false`. [ratatui][] support by `default-features = false`.
In addition to above dependencies, you also need to install [crossterm][] or [termion][] or [termwiz][] to initialize 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 your application and to receive key inputs. Note that the dependency versions of [crossterm][] crate and [termion][]
between [ratatui][] and [tui-rs][]. Please select the same dependency version. For example, [tui-rs][] depends on crate differ between [ratatui][] and [tui-rs][]. Please make sure to use the same version that matches the package you
[crossterm][] v0.2.5 or [termion][] v1.5 where both crates are older than [ratatui][]'s dependencies. 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 ## Minimal Usage