hexedtech/codemp-nvim
3
0
Fork 0
mirror of https://github.com/hexedtech/codemp-nvim.git synced 2024-11-22 15:34:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: explain that commands come in stages

Browse source
This commit is contained in:
əlemi 2024-08-17 17:15:39 +02:00
parent 236b25e4c5
commit e0f12949c7
Signed by: alemi
GPG key ID: A4895B84D311642C
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -27,11 +27,19 @@ to interact with this plugin use the `:MP` command
| --- | --- | | --- | --- |
| `:MP toggle` | toggles the codemp sidebar | | `:MP toggle` | toggles the codemp sidebar |
| `:MP connect [host] [username] [password]` | to connect to server, user and pwd will be prompted if not given | | `: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 disconnect` | disconnects from server |
| `:MP id` | shows current client id | | `:MP id` | shows current client id |
| `:MP join <workspace>` | will join requested workspace; starts processing cursors, users and filetree | | `:MP join <workspace>` | will join requested workspace; starts processing cursors, users and filetree |
| | |
after a workspace is joined, more commands become available:
| command | description |
| --- | --- |
| `:MP leave <workspace>` | disconnect from a joined workspace | | `:MP leave <workspace>` | disconnect from a joined workspace |
| `:MP attach <buffer>` | will attach to requested buffer if it exists (opens a new local buffer and uses current window) | | `:MP attach <buffer>` | will attach to requested buffer if it exists (opens a new local buffer and uses current window) |
| `:MP detach <buffer>` | detach from a buffer and stop receiving changes | | `:MP detach <buffer>` | detach from a buffer and stop receiving changes |