[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours.

README.md

@@ -26,15 +26,7 @@ Features of bottom include:
 
 - Maximizing of widgets of interest to take up the entire window.
 
-Details about each widget can be found [here](./docs/widgets.md).
-
-The compatibility of each widget and operating systems are, as of version 0.1.0, as follows:
-
-| OS                                                     | CPU | Memory | Disks | Temperature | Processes | Networks |
-| ------------------------------------------------------ | --- | ------ | ----- | ----------- | --------- | -------- |
-| Linux (tested on Arch Linux, using Kitty Terminal)     | ✓   | ✓      | ✓     | ✓           | ✓         | ✓        |
-| Windows (tested on Windows 10, using Powershell)       | ✓   | ✓      | ✓     | ✗           | ✓         | ✓        |
-| macOS (tested on macOS Catalina, using Kitty Terminal) | ✓   | ✓      | ✓     | ✓           | ✓         | ✓        |
+More details about each widget and compatibility can be found [here](./docs/widgets.md).
 
 ## Installation
 

docs/config.md

@@ -28,6 +28,8 @@ Another use is to set colours, under the `[colors]`. The following labels are cu
 - Cursor colour (`cursor_color="#ffffff"`).
 - Current selected scroll entry colour (`scroll_entry_text_color="#282828"`, `scroll_entry_bg_color="#458588"`).
 
+Note some colours may not be compatible with the terminal you are using.
+
 ## Default Locations
 
 bottom will check specific locations by default for a config file.

docs/widgets.md

@@ -1,31 +1,47 @@
 # Widgets
 
-More information about each widget:
+## Compatibility
 
-## CPU
+The compatibility of each widget and operating systems are, as of version 0.2.0, as follows:
+
+| OS      | CPU | Memory | Disks | Temperature | Processes | Networks |
+| ------- | --- | ------ | ----- | ----------- | --------- | -------- |
+| Linux   | ✓   | ✓      | ✓     | ✓           | ✓         | ✓        |
+| Windows | ✓   | ✓      | ✓     | ✗           | ✓         | ✓        |
+| macOS   | ✓   | ✓      | ✓     | ✓           | ✓         | ✓        |
+
+- Linux is tested on Arch Linux, using Kitty Terminal.
+
+- Windows is tested on Windows 10, using Powershell.
+
+- macOS is tested on macOS Catalina, using the base Terminal and Kitty Terminal.
+
+## Widget Information
+
+### CPU
 
 - Supports displaying specific cores (or average CPU usage if enabled); use `/` to allow for selection of cores to display, and `Space` to enable/disable them.
 
-## Memory
+### Memory
 
 - If no SWAP is available (size of 0) then no entry will show for SWAP.
 
-## Disk
+### Disk
 
 - I'm aware that Windows disk names are a bit strange... not sure if there's much I can do about it.
 
-## Temperature
+### Temperature
 
 - Temperature sensors are sorted alphabetically and then by temperature (descending).
 
 - Personally I found this to not work on Windows but YMMV.
 
-## Network
+### Network
 
 - I'm aware that you cannot easily determine which graph line belongs to which entry unless you maximize - this is due to a limitation of tui-rs, and will be solved in a future release of the library.
 
 - The graph is scaled logarithmically, by bytes, kibibytes, mebibytes, and gibibytes. I personally think this is enough for most people, but if you have a use case in which this isn't enough, let me know and I'll add in ways to increase it.
 
-## Processes
+### Processes
 
 - Filtering follows the convention of VS Code in terms of behaviour. For example, even in regex mode, it is not case sensitive if that is not enabled.