X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation.vim/blobdiff_plain/41d7b8b05c6b52f414182fb3beae0c36991978a7..35edebac06d1d8550ee7fa8d0336b6313228431c:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 3cad5cb..5818c72 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,21 @@ This is a syntax for api notation, a simple notation I've been using for annotating module APIs in specs and other documents. +## Installing + +Install with pathogen: + +1. Clone the repo or copy the files to your `.vim/bundle` dir +2. Reload the vim +3. Enjoy the vim + ## API Notation Reference 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) @@ -29,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?