updates readme with show_host_usage feature

jupyter-server · Oct 6, 2023 · ec115fd · ec115fd
1 parent e6f707b
commit ec115fd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -26,7 +26,13 @@ Kernel resource usage can be displayed in a sidebar for IPython kernels with
 
 The kernel usage is available for Notebook 7.x too which can be enabled at
 `View -> Right Sidebar -> Show Kernel Usage`. In the case of JupyterLab interface, it is
-enough to click `tachometer` icon on the right sidebar.
+enough to click `tachometer` icon on the right sidebar. 
+
+If you want to hide information from the Kernel Usage sidebar
+you can set `--ResourceUseDisplay.show_host_usage=False` to hide `Host CPU` and `Host Virtual Memory` information. The default is
+set as `True`, i.e. show all the information.
+
+![Screenshot for kernel usage with limited info](./doc/kernel-usage-limited-info.png)
 
 The package provides an alternative frontend for the `jupyter-resource-usage` metrics:
 

diff --git a/doc/kernel-usage-limited-info.png b/doc/kernel-usage-limited-info.png