Update README.md

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

diff --git a/README.md b/README.md
index 64dfd235e665da4cbee78f3fc03ecae8082726df..da362d191e8994edc9f3a714d09a811145f8e5bf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,11 +5,34 @@ annotating module APIs in specs and other documents.
 
 ## Installing
 
-??
+### From Command Line
+
+`apm install api-notation`
+
+### From GUI
+
+#### Open the Package Manager from Palette Manager
+
+1. Press `⌘⇧P` on OSX or `⌃⇧P` on Windows/Linux to open the palette manager
+2. Look for `Install Packages and Themes`
+
+#### Open the Package Manager from Preferences
+
+1. Go to `Atom -> Preferences` menu
+2. Go to `Install`
+
+#### Install it
+
+1. Search for `api-notation` in the search bar
+2. Click Install
+
+## Usage
+
+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 [text file][api-reference], so
 check that to be sure. But here's a reproduction of the notation.
 
 ```
@@ -43,5 +66,5 @@ Like this.
 
 ![Like this.][api-example]
 
-[api-reference]: https://gist.github.com/benbeltran/4694c46fcec131468e34
+[api-reference]: https://gitlab.com/rbdr/txt/-/blob/main/reference/api_notation.md
 [api-example]: https://i.imgur.com/5WXuf4u.png