From: Ben Beltran <redacted>
Date: Tue, 23 Jun 2015 14:59:40 +0000 (-0500)
Subject: First commit, basic readme
X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation.vim/commitdiff_plain/41d7b8b05c6b52f414182fb3beae0c36991978a7

First commit, basic readme
---

41d7b8b05c6b52f414182fb3beae0c36991978a7
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3cad5cb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# API Notation Syntax for Vim
+
+This is a syntax for api notation, a simple notation I've been using for
+annotating module APIs in specs and other documents.
+
+## 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
+   + class property
+   - instance property
+  ~> listened events (socket)
+  +> listened events (class/module)
+  -> listened events (instance)
+  <~ dispatched events (socket)
+  <+ dispatched events(class/module)
+  <- dispatched events (instance)
+  :: class method
+   # instance method
+
+Other symbols
+  => returns
+->() callback return
+[xx] optional
+<xx> data type
+
+Recommended order: class first, then sockets, then instance. Internally:
+Properties, events, methods.
+```
+
+## How 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