X-Git-Url: https://git.r.bdr.sh/rbdr/api-notation-atom/blobdiff_plain/3227ae80072008dc87215dcbade6781d1ef769d7..efdd348d2bee48c06300186bfb64a73586867f7d:/README.md 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