X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation.vim/blobdiff_plain/83cf70a781bb695bf6f5014a7399d4eab6aa784d..b59ef9367afd016f26641b421685d09cd3420e7e:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 3428fa7..008fbea 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ This is a syntax for api notation, a simple notation I've been using for annotating module APIs in specs and other documents. +*Using Neovim? Try [tree-sitter-api-notation][new] instead* + ## Installing Install with pathogen: @@ -41,11 +43,12 @@ Properties, events, methods. // Anything after two forward slashes is a comment ``` -## How does it look like? +## What does it look like? Like this. ![Like this.][api-example] -[api-reference]: https://gitlab.com/rbdr/txt/-/blob/main/reference/api_notation.md +[api-reference]: https://www.unlimited.pizza/api.html [api-example]: https://i.imgur.com/OreLcmE.png +[new]: https://git.sr.ht/~rbdr/tree-sitter-api-notation