diff --git a/README.md b/README.md index 51a22ea..beb44a4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # codemp-nvim -codemp logo + +codemp logo + > code multiplexer for neovim CodeMP is a **collaborative** text editing plugin to work remotely. @@ -17,20 +19,22 @@ and low network footprint, meaning even slow connections can provide stable real ## usage 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 - - * `:MP disconnect` disconnects from server - * `:MP id` shows current client id - * `:MP join ` will join requested workspace; starts processing cursors, users and filetree - - * `: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 - * `:MP share` shares current file: creates a new buffer with local file's content, and attach to it - * `:MP sync` forces resynchronization of current buffer - * `:MP create ` will create a new empty buffer in workspace - * `:MP delete ` will delete a buffer from workspace +| command | description | +| --- | --- | +| `: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 disconnect` | disconnects from server | +| `:MP id` | shows current client id | +| `:MP join ` | will join requested workspace; starts processing cursors, users and filetree | +| | | +| `: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 | +| `:MP share` | shares current file: creates a new buffer with local file's content, and attach to it | +| `:MP sync` | forces resynchronization of current buffer | +| `:MP create ` | will create a new empty buffer in workspace | +| `:MP delete ` | will delete a buffer from workspace | ### quick start * first connect to server with `:MP connect`