diff options
| author | Ben Beltran <ben@nsovocal.com> | 2015-09-05 14:37:52 -0500 |
|---|---|---|
| committer | Ben Beltran <ben@nsovocal.com> | 2015-09-05 14:37:52 -0500 |
| commit | efdd348d2bee48c06300186bfb64a73586867f7d (patch) | |
| tree | 2fa001d5b18b59b9cd2af21d576ab30d873ae83f /README.md | |
| parent | 3227ae80072008dc87215dcbade6781d1ef769d7 (diff) | |
Updates README with install instructions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 24 insertions, 1 deletions
@@ -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 |