diff --git a/README.md b/README.md index 792c369..c132b6e 100644 --- a/README.md +++ b/README.md @@ -21,23 +21,44 @@ text editor can be easily put as part of your TUI application. ## Examples -- [`minimal`](./examples/minimal.rs): Minimal usage with [crossterm][] support - minimal example -- [`editor`](./examples/editor.rs): Simple text editor to edit multiple files - editor example -- [`single_line`](./examples/single_line.rs): Single-line input form with float number validation - single line example -- [`split`](./examples/split.rs): Two split textareas in a screen and switch them - multiple textareas example -- [`termion`](./examples/termion.rs): Minimal usage with [termion][] support -- [`variable`](./examples/variable.rs): Simple textarea with variable height following the number of lines - -Running `cargo run` in this repository can demonstrate usage of tui-textarea. +Running `cargo run --example` in this repository can demonstrate usage of tui-textarea. ```sh cargo run --example minimal ``` +### [`minimal`](./examples/minimal.rs) + +Minimal usage with [crossterm][] support. + +minimal example + +### [`editor`](./examples/editor.rs) + +Simple text editor to edit multiple files. + +editor example + +### [`single_line`](./examples/single_line.rs) + +Single-line input form with float number validation. + +single line example + +### [`split`](./examples/split.rs) + +Two split textareas in a screen and switch them. An example for multiple textarea instances. + +multiple textareas example + +### [`termion`](./examples/termion.rs) + +Minimal usage with [termion][] support. To run this example, `termion` feature needs to be enabled. + +### [`variable`](./examples/variable.rs) + +Simple textarea with variable height following the number of lines. + ## Installation Add `tui-textarea` crate to dependencies in your `Cargo.toml`. This enables crossterm backend support by default.