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 +} diff --git a/README.md b/README.md index bf6b277a..f4ab4d81 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,15 @@ You can currently install by cloning and building yourself using `cargo build -- macOS support will hopefully come soonTM. -## Usage +The compatibility of each widget and operating systems are, as of version 0.1.0, as follows: -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. +| 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 | + +## 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