From a8d077bf6e68822c8f473efff2c43c8445104a1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomek=20Wa=C5=82kuski?= Date: Tue, 15 Dec 2020 09:59:53 +0100 Subject: [PATCH] Describe usage in the README I know `doc/jack_in.txt` is a way to go, but sometimes it's nice to take a quick look at the README to assess the library. --- README.adoc | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/README.adoc b/README.adoc index 851e0fa..5fcd198 100644 --- a/README.adoc +++ b/README.adoc @@ -11,3 +11,47 @@ Plug 'clojure-vim/vim-jack-in' " Only in Neovim: Plug 'radenling/vim-dispatch-neovim' ---- + +Provides a couple of helper commands for "jacking" in to a Clojure REPL by +auto-starting it. Highly inspired by CIDER.el's feature by the same name. + +== Commands + +These run inside the directory vim is currently in. In the future it would be +nice to run relative to the current file. +To run boot & lein, `dispatch-:Start` is used with the bang option. + +=== Boot +[source] +---- +:Boot [args] +---- +Start boot with CIDER-nrepl and Refactor-nrepl automatically injected. +[args] is a list of tasks to run in boot. If not provided, +`g:default_boot_task` is used instead. + +=== Clj +[source] +---- +:Clj [args] +---- +Start clj with CIDER-nrepl and Refactor-nrepl automatically injected. +[args] is a list of options to run in clj. If not provided, +no aditional options will be used. + +=== Lein +[source] +---- +:Lein [args] +---- +Start lein with CIDER-nrepl and Refactor-nrepl automatically injected. +[args] is a list of tasks to run in lein. If not provided, +`:default_lein_task` is used instead. + +== Variables + +`g:default_boot_task` +Control the default task to start boot with. Defaults to "repl" + +`g:default_lein_task` +Control the default task to start lein with. Defaults to "repl"