X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation.vscode/blobdiff_plain/e6c2e653ab8ad7d115d29a407c99aaecb179adb1..2ebac1350e21da323c9c937c67a6ad13c5be359e:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 2d5e725..d472f13 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,24 @@ annotating module APIs in specs and other documents. ### From Command Line -TBD +`code --install-extension rbdr.api-notation` + +### From GUI + +#### Open the Extension Manager from Palette Manager + +1. Press `⌘⇧P` on OSX or `⌃⇧P` on Windows/Linux to open the palette manager +2. Look for `Install Ext4ensions + +#### Open the Package Manager from Preferences + +1. Go to `Code -> Preferences -> Extensions` menu item + +#### Install it + +1. Search for `api-notation` in the search bar +2. Click Install + ## Usage @@ -15,7 +32,7 @@ Open a `.api` file, or set it as your syntax. ## 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 [textt file][api-reference], so check that to be sure. But here's a reproduction of the notation. ``` @@ -49,5 +66,5 @@ Like this. ![Like this.][api-example] -[api-reference]: https://gist.github.com/rbdr/4694c46fcec131468e34 +[api-reference]: https://gitlab.com/rbdr/txt/-/blob/main/reference/api_notation.md [api-example]: https://i.imgur.com/63TyFMe.png