Skip to content

Format Docs #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Format Docs #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23eaf9c
update README
natesire Apr 13, 2021
714b5a2
Update README.md
natesire Apr 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ A client library for creating Neovim plugins written in Clojure.

## Usage

<details>
<summary>Repl</summary>

### Repl

Launch Neovim, explicitly setting the `NVIM_LISTEN_ADDRESS`
Expand All @@ -31,11 +34,22 @@ user=> (require '[neovim-client.1.api :as api])
user=> (api/command c ":echo 'Hello Neovim!'")
...
```

</details>
<details>
<summary>Tmux + Repl</summary>

Alternatively, if you've got tmux installed, you can use run the script
`./tmux-run-dev.sh`, which will start Neovim, a repl, and execute similar
setup code.

I almost forgot Tmux's navigation keys to switch between panes.

```Ctrl-b arrow keys```

Your Tmux setup might use a different leader key for commands. Maybe Ctrl-c

</details>

### Examples

#### Included Sample Plugin
Expand Down