X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation.vim/blobdiff_plain/d047e0072903bfccf7f06ecf2fe19a17110c11cc..HEAD:/README.md diff --git a/README.md b/README.md index 993068c..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,11 +15,11 @@ 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. ``` -Class Members +NameOfClass.WithPossibleNamespace + class property - instance property ~> listened events (socket) @@ -37,13 +39,16 @@ Other symbols Recommended order: class first, then sockets, then instance. Internally: 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-example]: http://ns.vc/1gXwQ.png +[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