From e0f12949c7ecbdb5ef64bec05b3a530a77eb5069 Mon Sep 17 00:00:00 2001 From: alemi Date: Sat, 17 Aug 2024 17:15:39 +0200 Subject: [PATCH] docs: explain that commands come in stages --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 188a14a..1b695db 100644 --- a/README.md +++ b/README.md @@ -27,11 +27,19 @@ to interact with this plugin use the `:MP` command | --- | --- | | `:MP toggle` | toggles the codemp sidebar | | `:MP connect [host] [username] [password]` | to connect to server, user and pwd will be prompted if not given | -| | | + +once connected, more commands become available: + +| command | description | +| --- | --- | | `:MP disconnect` | disconnects from server | | `:MP id` | shows current client id | | `:MP join ` | will join requested workspace; starts processing cursors, users and filetree | -| | | + +after a workspace is joined, more commands become available: + +| command | description | +| --- | --- | | `:MP leave ` | disconnect from a joined workspace | | `:MP attach ` | will attach to requested buffer if it exists (opens a new local buffer and uses current window) | | `:MP detach ` | detach from a buffer and stop receiving changes |