Prepare 1.0.1 release

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

diff --git a/README.md b/README.md
index 64dfd235e665da4cbee78f3fc03ecae8082726df..717b43604581e88822d8a348646aa086f19ba04f 100644 (file)
--- 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