Skip to content

Commit 1dea92f

Browse files
committed
Update README to describe api_level support
1 parent eeb21cd commit 1dea92f

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
# neovim-client
22

3-
A Neovim client library for creating plugins written in Clojure.
3+
A client library for creating Neovim plugins written in Clojure.
44

5-
## Supported API Versions
5+
## Neovim API Versions (Levels)
66

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()`.
912

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:
1116

12-
### Neovim
17+
* Updating the API metadata `$> nvim --api-info > resources/api-info.mp`
1318

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
1622

17-
### Java
23+
* [Neovim](https://github.com/neovim/neovim)
1824

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
2027

2128
## Usage
2229

0 commit comments

Comments
 (0)