aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2015-09-05 14:37:52 -0500
committerBen Beltran <ben@nsovocal.com>2015-09-05 14:37:52 -0500
commitefdd348d2bee48c06300186bfb64a73586867f7d (patch)
tree2fa001d5b18b59b9cd2af21d576ab30d873ae83f /README.md
parent3227ae80072008dc87215dcbade6781d1ef769d7 (diff)
Updates README with install instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 64dfd23..717b436 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,30 @@ 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` | Header One | Header Two |
+
+#### 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