X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation.vim/blobdiff_plain/b201df0f3143d9c60d015787364d5c7d86e34ede..refs/heads/main:/README.md?ds=inline diff --git a/README.md b/README.md index deb304d..11b2ee9 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: @@ -13,7 +15,7 @@ Install with pathogen: ## API Notation Reference -The most recent reference as of now is in this [gist][api-reference], so +The most recent reference as of now is in this [text file][api-reference], so check that to be sure. But here's a reproduction of the notation. ``` @@ -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