release v0.3

aisuneko · Jul 13, 2022 · e8ed8f5 · e8ed8f5
1 parent 702cc4d
commit e8ed8f5
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,9 @@
 # Changelog
+v0.3 (2022/07/13)
+- Add support for CPU temperature info, powered by lm_sensors (only when ran directly on host)
+- Add flags to override existing settings in config file
+- Bug fixes
+
 v0.2.1 (2022/05/08)
 - Code cleanup
 - minor UI tweak

diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@ A htop-like status monitor for Proxmox VE servers, powered by python curses, wit
 ![connected to my own PVE server](screenshot.jpg)
 ## Installation
 `pip install requests proxmoxer proxcat`
+(optional) `pip install PySensors` for CPU temperature info support (only when ran directly on PVE host)
 
 Or, clone repository and run `pip install .`. 
 
@@ -30,8 +31,12 @@ Or, clone repository and run `pip install .`.
 
    [Settings]
    # set data update interval (in ms), optional
-   UpdateInterval = 1000
+   UpdateInterval = 
+   # whether to enable host CPU temperature info (requires lm_sensors and PySensors). Disabled by default.
+   ShowSensors = False
    ```
+   The options in [Settings] can be overriden by command-line flags; see `-h` or `--help` for details.
+
 3. run the `proxcat` command.
    > Keybindings:
    > 
@@ -45,7 +50,8 @@ see [CHANGELOG.md](CHANGELOG.md).
 
 ## Todo
 - [ ] Switch entirely to `pyproject.toml`
-- [ ] Add optional lm_sensors support for HW monitoring (if ran on host)
+- [x] Add optional lm_sensors support for HW monitoring (if ran on host)
+- [ ] Change time display to difference between host and local client
 - [ ] More functionality for curses UI (custom sorting, ...)
 - [ ] Invoke VM/CT jobs within app
 - [ ] **Optional headless/daemon mode with WebUI**