X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation.tmLanguage/blobdiff_plain/190aa87edc7ddae6df2fc9b619d63df24ce75cdd..435c1a9390e132101a826ff23be14b9f3f10b0f4:/README.md?ds=sidebyside diff --git a/README.md b/README.md index c84c451..935795b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ -# API Notation Syntax for TextMate & Sublime Text +# API Notation Syntax for Sublime Text This is a syntax for api notation, a simple notation I've been using for annotating module APIs in specs and other documents. +It could work for TextMate since it's a tmLanguage file. But you need to +create a tmBundle and god knows what else. So for now, just Sublime. +Sorry. + ## Installing ???? ## 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. ``` @@ -43,5 +47,5 @@ Like this. ![Like this.][api-example] -[api-reference]: https://gist.github.com/benbeltran/4694c46fcec131468e34 -[api-example]: ???? +[api-reference]: https://gitlab.com/rbdr/txt/-/blob/main/reference/api_notation.md +[api-example]: https://i.imgur.com/ogBqI7O.png