summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Leferry 2 <alexherbo2@gmail.com>2019-03-17 15:50:26 +0100
committerAlex Leferry 2 <alexherbo2@gmail.com>2019-03-17 16:04:09 +0100
commit5f6f35258f633658bf617543bbfd175314f75f29 (patch)
tree21ed3ba2a4f13dfa0d83afebb150ae41a72a7b3c
parentfd1fbaace4b9309a1504a7ecebf6d97bc946b992 (diff)
Use documentation from Reddit
https://reddit.com/r/kakoune/comments/b1z8fc/connect_extension/
-rw-r--r--README.md24
1 files changed, 18 insertions, 6 deletions
diff --git a/README.md b/README.md
index 8af959a..28f09f8 100644
--- a/README.md
+++ b/README.md
@@ -18,22 +18,34 @@ pathogen-infect /home/user/repositories/github.com/alexherbo2/connect.kak
## Usage
-Create a new terminal with `:connect` and edit a file with say, a file explorer.
+You can use `:connect` to create a new terminal with `[e]dit`, `[b]uffer` and `EDITOR` connected to the client.
-The file will be opened in the client from where `:connect` was executed by using `EDITOR`.
+If you open a file using the shell command `edit` or an application using the default editor,
+the file will be opened in the client from where `:connect` was executed.
-You can also use the `[e]dit` and `[b]uffer` shell commands available in `PATH`.
+You can also open a buffer by using the `buffer` command (or its alias `b`).
+With no argument, `buffer` will list the available buffers.
### Examples
-**Example** – [lf] integration:
+``` kak
+:connect # Spawn a terminal
+```
+
+From that terminal:
+
+``` sh
+$ edit example.txt
+```
+
+You can also run the shell commands from Kakoune.
+
+For example, [lf] and [fzf] integration can be:
``` kak
def lf %(connect lf)
```
-**Example** – [fzf] integration:
-
``` kak
def fzf-files %(connect edit $(fzf))
```