From bbada47a9c31aa1eb454c2d29722c78cd1a2cc46 Mon Sep 17 00:00:00 2001
From: Eugene Cheung <ey.cheung@outlook.com>
Date: Wed, 13 Jul 2016 19:25:15 -0400
Subject: [PATCH] Add documentation

---
 README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 53 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index de4a2eb..0d301d7 100644
--- a/README.md
+++ b/README.md
@@ -6,13 +6,59 @@
 
 An Angular 2 sidebar component.
 
-*Documentation coming soon*
 
-
-### Development
+## Installation
 
 ```shell
-npm install
-typings install
-npm start
-```
\ No newline at end of file
+npm install --save ng2-sidebar
+```
+
+
+## Usage
+
+Import the component and add it to the list of directives on your component:
+
+```typescript
+import Sidebar from 'ng2-sidebar';
+
+@Component({
+  selector: 'example',
+  directives: [Sidebar],
+  template: `
+    <ng2-sidebar [(open)]="_open">
+      <p>Sidebar contents</p>
+    </ng2-sidebar>
+
+    <button (click)="_toggleSidebar()">Toggle sidebar</button>
+  `
+})
+export class MyComponent {
+  private _open: boolean = false;
+
+  private _toggleSidebar() {
+    this._open = !this._open;
+  }
+}
+```
+
+### Options
+
+#### `[(open)]="boolean_value"`
+Boolean input value that controls the visibility of the sidebar. This should be two-way bound in case
+the value changes when the sidebar is closed by clicking outside of it when `closeOnClickOutside` is
+enabled.
+
+#### `[pullRight]="boolean_value"`
+Boolean input value
+
+#### `[closeOnClickOutside]="boolean_value"`
+Boolean input value that controls whether clicking outside of the open sidebar will close it.
+
+#### `[sidebarClassName]="'string_value'"`
+A string used as an additional class name on the sidebar element.
+
+#### `(onOpen)="func_call()"`
+An output event, emitted when the sidebar is opened.
+
+#### `(onClose)="func_call()"`
+An output event, emitted when the sidebar is closed.