add yml config file, client now does not depends on .env

README.md

@@ -2,7 +2,7 @@
 
 a utility that allows you to manage your computers.
 
-*Main Idea*
+_Main Idea_
 server can send to every client "what to do". Centralized control for all clients.
 
 ## Development
@@ -11,6 +11,42 @@ server can send to every client "what to do". Centralized control for all client
 pip install -e .[dev]
 ```
 
+## Client config
+
+The client reads YAML config files. The server still use
+`.env` for server-side settings such as `NEXUS_SYNC_CLIENT_TOKENS`.
+
+Client config is searched in this order:
+
+1. `$(pwd)/nexus.yml`
+2. `$(pwd)/nexus.yaml`
+3. `$XDG_CONFIG_HOME/nexus.yml`
+4. `$XDG_CONFIG_HOME/nexus.yaml`
+5. `~/.config/nexus.yml`
+6. `~/.config/nexus.yaml`
+7. `~/.config/nexus/config.yml`
+8. `~/.config/nexus/config.yaml`
+
+Example:
+
+```yaml
+server_url: "http://127.0.0.1:5852"
+client_id: "linux-client"
+client_token: "change-me-client-token"
+allowed_commands:
+  - name: hostname
+    description: "Get the hostname of the client machine"
+    cmd: "hostname"
+  - name: network_interfaces
+    description: "Get network interface information"
+    cmd: "ip addr show"
+logging_level: "INFO"
+```
+
+Template examples are available in `template/` for Linux, Windows, and Darwin.
+The client reports only command `name` and `description` to the server; `cmd`
+stays local to the client config.
+
 ## Current design
 
 - API contract: [docs/api.md](docs/api.md)
@@ -23,7 +59,6 @@ pip install -e .[dev]
 make [client|server]
 ```
 
-
 ### To test
 
 ```