From 51fae7e2d252615deb8a30ed756fef588fcf3512 Mon Sep 17 00:00:00 2001 From: rhysd Date: Sat, 15 Apr 2023 23:17:32 +0900 Subject: [PATCH] describe `crossterm` or `termion` is necessary to be installed in user's project --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 63332f2..741a757 100644 --- a/README.md +++ b/README.md @@ -150,11 +150,12 @@ ratatui = "*" tui-textarea = { version = "*", features = ["ratatui-crossterm"], default-features=false } ``` -**Note:** [tui-rs][] support and [ratatui][] support are exclusive. When you use [ratatui][] support, you must disable +Note that [tui-rs][] support and [ratatui][] support are exclusive. When you use [ratatui][] support, you must disable [tui-rs][] support by `default-features=false`. -**Note:** Versions of [crossterm][] crate are different between [tui-rs][] and [ratatui][]. Please choose the correct -version as dependency of your project. +In addition to above dependencies, you also need to install [crossterm][] or [termion][] to initialize your application +and to receive key inputs. Note that version of [crossterm][] crate is different between [tui-rs][] and [ratatui][]. +Please select the correct version. ## Minimal Usage