diff --git a/README.md b/README.md index db0fccb..cb1960f 100644 --- a/README.md +++ b/README.md @@ -134,24 +134,23 @@ version = "0.23" features = ["event-stream"] ``` -| Feature | Description | -| :----- | :----- | -| `event-stream` | `futures::Stream` producing `Result`.| -| `serde`| Se/dese/rializing of events. | +| Feature | Description | +|:---------------|:---------------------------------------------| +| `event-stream` | `futures::Stream` producing `Result`. | +| `serde` | Se/dese/rializing of events. | ### Dependency Justification -| Dependency | Used for | Included | -| :----- | :----- | :----- -| `bitflags` | `KeyModifiers`, those are differ based on input.| always -| `parking_lot` | locking `RwLock`s with a timeout, const mutexes. | always -| `libc` | UNIX terminal_size/raw modes/set_title and several other lowlevel functionality. | 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 -| `winapi`| Used for low-level windows system calls which ANSI codes can't replace | windows only -| `futures-core`| For async stream of events | only with `event-stream` feature flag -| `serde`| Se/dese/rializing of events | only with `serde` feature flag - +| Dependency | Used for | Included | +|:---------------|:---------------------------------------------------------------------------------|:--------------------------------------| +| `bitflags` | `KeyModifiers`, those are differ based on input. | always | +| `parking_lot` | locking `RwLock`s with a timeout, const mutexes. | always | +| `libc` | UNIX terminal_size/raw modes/set_title and several other lowlevel functionality. | 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 | +| `winapi` | Used for low-level windows system calls which ANSI codes can't replace | windows only | +| `futures-core` | For async stream of events | only with `event-stream` feature flag | +| `serde` | Se/dese/rializing of events | only with `serde` feature flag | ### Other Resources diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 9492ac5..d99d4e2 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -39,11 +39,11 @@ _Languages & Frameworks_ -> _Rust_ -> _Rustfmt_ -> _Run rustfmt on save_. ### Max Line Length -| Type | Max line length | -| :--- | ---: | -| Code | 100 | -| Comments in the code | 120 | -| Documentation | 120 | +| Type | Max line length | +|:---------------------|----------------:| +| Code | 100 | +| Comments in the code | 120 | +| Documentation | 120 | 100 is the [`max_width`](https://github.com/rust-lang/rustfmt/blob/master/Configurations.md#max_width) default value. diff --git a/examples/README.md b/examples/README.md index 4ae3323..2b0fc88 100644 --- a/examples/README.md +++ b/examples/README.md @@ -12,12 +12,12 @@ The examples are compatible with the latest release. │   └── event-* │   └── stderr ``` -| File Name | Description | Topics -| :------- | :------- | :------- | -| `examples/interactive-test` | interactive, walk trough, demo | cursor, style, event -| `event-*`| event reading demos | (async) event reading -| `stderr` | crossterm over stderr demo | raw mode, alternate screen, custom output -| `is_tty` | Is this instance a tty ? | tty | +| File Name | Description | Topics | +|:----------------------------|:-------------------------------|:------------------------------------------| +| `examples/interactive-test` | interactive, walk trough, demo | cursor, style, event | +| `event-*` | event reading demos | (async) event reading | +| `stderr` | crossterm over stderr demo | raw mode, alternate screen, custom output | +| `is_tty` | Is this instance a tty ? | tty | ## Run examples