X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation.vim/blobdiff_plain/d047e0072903bfccf7f06ecf2fe19a17110c11cc..b201df0f3143d9c60d015787364d5c7d86e34ede:/README.md diff --git a/README.md b/README.md index 993068c..deb304d 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ The most recent reference as of now is in this [gist][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,6 +37,8 @@ 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? @@ -45,5 +47,5 @@ Like this. ![Like this.][api-example] -[api-reference]: https://gist.github.com/benbeltran/4694c46fcec131468e34 -[api-example]: http://ns.vc/1gXwQ.png +[api-reference]: https://gitlab.com/rbdr/txt/-/blob/main/reference/api_notation.md +[api-example]: https://i.imgur.com/OreLcmE.png