aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..32ffbdd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# tree-sitter-api-notation
+
+This is a tree-sitter parser for [api-notation][api-notation].
+
+## Neovim plugin
+
+If you use `nvim-treesitter`, you can also include this as a plugin and it will
+make sure it's configured correctly.
+
+```
+require('lazy').setup({
+ ...
+ 'https://git.sr.ht/~rbdr/tree-sitter-api-notation'
+ ...
+}
+```
+
+[api-notation]: https://unlimited.pizza/api.html