From d3dbcd8542189afa12a95d642971fb8be4a08275 Mon Sep 17 00:00:00 2001 From: Alex Leferry 2 Date: Sun, 17 Mar 2019 13:03:01 +0100 Subject: README: Add an Examples section --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index e9cfa2a..d18bb39 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,24 @@ The file will be opened in the client from where `:connect` was executed by usin You can also use the `[e]dit` and `[b]uffer` shell commands available in `PATH`. +### Examples + +**Example** – [lf] integration: + +``` kak +def lf %(connect lf) +``` + +**Example** – [fzf] integration: + +``` kak +def fzf-files %(connect edit $(fzf)) +``` + +``` kak +def fzf-buffers %(connect buffer $(buffer | fzf)) +``` + ## Commands - `connect-shell [program] [arguments]`: Run a shell with `[e]dit`, `[b]uffer` and `EDITOR` connected to the current client @@ -41,3 +59,5 @@ You can also use the `[e]dit` and `[b]uffer` shell commands available in `PATH`. [IRC]: https://webchat.freenode.net?channels=kakoune [IRC Badge]: https://img.shields.io/badge/IRC-%23kakoune-blue.svg [Pathogen]: https://github.com/alexherbo2/pathogen.kak +[lf]: https://github.com/gokcehan/lf +[fzf]: https://github.com/junegunn/fzf -- cgit v1.2.3