Bold warning

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

diff --git a/README.md b/README.md
index 3cad5cbea9ca488a4600bc10636d9c5173e46235..11b2ee9b2123f4d296f93c759a8f1bca8c330ca2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,13 +3,23 @@
 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:
+
+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
+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)
@@ -29,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