X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation.vim/blobdiff_plain/81f525f7bacfa65c7dfba314be92ec64a69c3901..HEAD:/README.md diff --git a/README.md b/README.md index ad13a05..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://gist.github.com/benbeltran/4694c46fcec131468e34 +[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