blasthavers/minicrossterm
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve Readme (#638)

Browse Source
This commit is contained in:
yjhn 2022-03-05 11:29:16 +02:00 committed by GitHub
parent e920d0cfd7
commit 72ce50ef49
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -71,7 +71,7 @@ WARNING: Do not change following heading title as it's used in the URL by other
- (Arch, Manjaro) KDE Konsole - (Arch, Manjaro) KDE Konsole
- (Arch) Kitty - (Arch) Kitty
- Linux Mint - Linux Mint
- OpenSuse/Linux Alacritty - (OpenSuse) Alacritty
This crate supports all UNIX terminals and Windows terminals down to Windows 7; however, not all of the This crate supports all UNIX terminals and Windows terminals down to Windows 7; however, not all of the
terminals have been tested. If you have used this library for a terminal other than the above list without terminals have been tested. If you have used this library for a terminal other than the above list without
@ -87,7 +87,7 @@ Click to show Cargo.toml.
```toml ```toml
[dependencies] [dependencies]
crossterm = "0.22" crossterm = "0.23"
``` ```
</details> </details>
@ -128,17 +128,16 @@ Checkout this [list](https://docs.rs/crossterm/0.14.0/crossterm/index.html#suppo
### Feature Flags ### Feature Flags
To optional feature flags.
```toml ```toml
[dependencies.crossterm] [dependencies.crossterm]
version = "0.17" version = "0.23"
features = ["event-stream"] features = ["event-stream"]
``` ```
| Feature | Description | | Feature | Description |
| :----- | :----- | | :----- | :----- |
| `event-stream` | `futures::Stream` producing `Result<Event>`.| | `event-stream` | `futures::Stream` producing `Result<Event>`.|
| `serde`| Se/dese/rializing of events. |
### Dependency Justification ### Dependency Justification
@ -150,8 +149,8 @@ features = ["event-stream"]
| `Mio` | event readiness polling, waking up poller | UNIX only | `Mio` | event readiness polling, waking up poller | UNIX only
| `signal-hook`| signalhook is used to handle terminal resize SIGNAL with Mio. | UNIX only | `signal-hook`| signalhook is used to handle terminal resize SIGNAL with Mio. | UNIX only
| `winapi`| Used for low-level windows system calls which ANSI codes can't replace | windows only | `winapi`| Used for low-level windows system calls which ANSI codes can't replace | windows only
| `futures-core`| Can be used to for async stream of events | only with a feature flag | `futures-core`| For async stream of events | only with `event-stream` feature flag
| `serde`| Se/dese/realizing of events | only with a feature flag | `serde`| Se/dese/rializing of events | only with `serde` feature flag
### Other Resources ### Other Resources