diff options
| author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2020-01-02 20:31:58 -0500 |
|---|---|---|
| committer | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2020-01-02 20:31:58 -0500 |
| commit | 4ae2882aa6f288841fdab064d8e89a9310708a47 (patch) | |
| tree | 0836d1666cad8e43829709a895f6dba3456e5876 | |
| parent | 9ff3cb7a52e22e8a79b7b9e37109faa94bfd061a (diff) | |
[skip travis] Update README with compatibility chart
| -rw-r--r-- | .markdownlint.json | 4 | ||||
| -rw-r--r-- | README.md | 28 |
2 files changed, 13 insertions, 19 deletions
diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 00000000..26593a22 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD013": false, + "MD033": false +} @@ -20,9 +20,15 @@ You can currently install by cloning and building yourself using `cargo build -- macOS support will hopefully come soon<sup>TM</sup>. -## Usage +The compatibility of each widget and operating systems are, as of version 0.1.0, as follows: + +| OS/Widget | CPU | Memory | Disks | Temperature | Processes | Networks | +| --------- | -------- | -------- | -------- | --------------------- | --------- | --------------------------------------------- | +| Linux | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| Windows | ✓ | ✓ | ✓ | Currently not working | ✓ | Partially supported (total RX/TX unavailable) | +| macOS | Untested | Untested | Untested | Untested | Untested | Untested | -Note that all options and keybindings on GitHub may reflect the current development build, and not that of the current releases. For now, refer to the [crate](https://crates.io/crates/bottom) README for documentation as of time of release. +## Usage ### Command line options @@ -84,23 +90,7 @@ Note that all options and keybindings on GitHub may reflect the current developm ### Mouse actions -[* Scrolling either scrolls through the list if the panel is a table (Temperature, Disks, Processes), or zooms in and out if it is a chart.]: <> - -- Scrolling currently only scrolls through the list if the panel is a table (Temperature, Disks, Processes). - -## Widget Functionality - -### CPU - -### Memory - -### Sensors - -### Disk - -### Network - -### Processes +- Scrolling with the mouse will go through lists/tables right now, similar to using the up/down arrow keys. ## Thanks, kudos, and all the like |