Update README.md

[rbdr/api-notation.vim] / README.md

diff --git a/README.md b/README.md
index 3cad5cbea9ca488a4600bc10636d9c5173e46235..deb304d792ebd8071f7964da4b9e165b5024d833 100644 (file)
--- 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.
 
 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.
 
 ```
 ## 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)
    + 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.
 
 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?
 ```
 
 ## How does it look like?


@@ -37,5 +47,5 @@ Like this.
 
 ![Like this.][api-example]
 
 
 ![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