Update readme
This commit is contained in:
parent
16d142a465
commit
fec0f9c846
1 changed files with 8 additions and 11 deletions
19
README.md
19
README.md
|
@ -2,9 +2,11 @@
|
|||
|
||||
## Requirements
|
||||
|
||||
## Installation
|
||||
- Only Gnome on Wayland is supported.
|
||||
- You need to install the Gnome Extension https://extensions.gnome.org/extension/4974/window-calls-extended/ for each user to monitor.
|
||||
- You need to run this script in the Gnome Session of the user, via creating a .desktop file and adding the application to Startup Applications with Gnome Tweaks for example.
|
||||
|
||||
### Linux
|
||||
## Installation
|
||||
|
||||
To install for example in your ~/.local/bin folder:
|
||||
```bash
|
||||
|
@ -18,16 +20,11 @@ sudo ./install.sh --destination /usr/local/bin
|
|||
|
||||
Change your configuration file in "${HOME}/.config/publish_active_windows.conf" (see the example in the config folder).
|
||||
|
||||
### Windows (from PowerShell)
|
||||
|
||||
Ensure you have "C:\Users\${env:USERNAME}\AppData\Roaming\Python\Python${python_version}\Scripts\" in your Path environment variable.
|
||||
|
||||
```powershell
|
||||
& $(where.exe pip).split()[0] install .
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
publish_active_windows.sh [--debug-level|-d CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] # Other parameters
|
||||
publish_active_windows.sh [--debug-level|-d CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] --ha-url <URL> --ha-token <TOKEN>
|
||||
```
|
||||
- URL should be something like https://myhomeassistant.example.org:8443
|
||||
- The TOKEN must be generated in HomeAssistant, under your profile, Security, Create token. This token will be readable to the user you want to monitor, and it could be able to publish and read any other data from HomeAssistant. At the moment HomeAssistant doesn't support more granular permissions that allow you to limit the access of this token.
|
||||
- Alternativaly you can use the option --config with a config gile containing ha_url and ha_token (underscores instead of hashes because of click module).
|
||||
|
|
Loading…
Reference in a new issue