File tree Expand file tree Collapse file tree 1 file changed +17
-10
lines changed Expand file tree Collapse file tree 1 file changed +17
-10
lines changed Original file line number Diff line number Diff line change 1
1
# neovim-client
2
2
3
- A Neovim client library for creating plugins written in Clojure.
3
+ A client library for creating Neovim plugins written in Clojure.
4
4
5
- ## Supported API Versions
5
+ ## Neovim API Versions (Levels)
6
6
7
- ;; TODO table, showing version of neovim-client version, neovim version (used
8
- ;; to generate metadata, and api levels supported
7
+ Neovim's RPC API is
8
+ [ versioned separately] ( https://github.com/neovim/neovim/pull/5535 ) from
9
+ Neovim itslef, using a monotonically increasing integer. The API's version is
10
+ tracked using a value called ` api_level ` , which can be found by examining the
11
+ output of ` :echo api_info() ` .
9
12
10
- ## Dependencies
13
+ Currently, levels 0 - 1 are supported.
14
+
15
+ In the future, this library can be updated to support a new level by:
11
16
12
- ### Neovim
17
+ * Updating the API metadata ` $> nvim --api-info > resources/api-info.mp `
13
18
14
- ;; TODO finish this section
15
- [ Neovim] ( https://github.com/neovim/neovim )
19
+ * Generating code from the metadata using ` neovim-client.parser/generate `
20
+
21
+ ## Dependencies
16
22
17
- ### Java
23
+ * [ Neovim ] ( https://github.com/neovim/neovim )
18
24
19
- You've probably already got this if you're using Clojure. Version 1.6 or later is required.
25
+ * [ Java Development Kit] ( http://www.oracle.com/technetwork/java/javase/overview/ )
26
+ (JDK) Standard Edition (SE) version 8
20
27
21
28
## Usage
22
29
You can’t perform that action at this time.
0 commit comments