]> git.r.bdr.sh - rbdr/api-notation.vscode/blobdiff - README.md
Update README.md
[rbdr/api-notation.vscode] / README.md
index 2d5e7255f48b3ded0675f81900a69b84ccdd6711..d472f13d0055035e45be740099e9bb1133714a3a 100644 (file)
--- 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