Update documentations

Author: devxoul

README.md

@@ -4,13 +4,30 @@
 [![CocoaPods](http://img.shields.io/cocoapods/v/RxKeyboard.svg)](https://cocoapods.org/pods/RxKeyboard)
 [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
 
-RxKeyboard provides a reactive way of keyboard handling. Forget about `UIKeyboardWillShow` and `UIKeyboardWillHide`. It also perfectly works with `UIScrollViewKeyboardDismissMode.interactive`.
+RxKeyboard provides a reactive way of observing keyboard frame changes. Forget about keyboard notifications. It also perfectly works with `UIScrollViewKeyboardDismissMode.interactive`.
 
 ![rxkeyboard](https://cloud.githubusercontent.com/assets/931655/19223656/14bd915c-8eb0-11e6-93ea-7618fc9c5d81.gif)
 
-## At a Glance
+## Getting Started
 
-Observing keyboard frame:
+RxKeyboard provides two [`Driver`](https://github.com/ReactiveX/RxSwift/blob/master/Documentation/Units.md#driver-unit)s.
+
+```swift
+/// An observable keyboard frame.
+let frame: Driver<CGRect>
+
+/// An observable visible height of keyboard. Emits keyboard height if the keyboard is visible
+/// or `0` if the keyboard is not visible.
+let visibleHeight: Driver<CGFloat>
+```
+
+Use `RxKeyboard.instance` to get singleton instance.
+
+```swift
+RxKeyboard.instance
+```
+
+Subscribe `RxKeyboard.instance.frame` to observe keyboard frame changes.
 
 ```swift
 RxKeyboard.instance.frame
@@ -20,17 +37,43 @@ RxKeyboard.instance.frame
   .addDisposableTo(disposeBag)
 ```
 
-Observing keyboard visible height:
+## Tips and Tricks
 
-```swift
-RxKeyboard.instance.visibleHeight
-  .drive(onNext: { keyboardVisibleHeight in
-    toolbarBottomConstraint.constant = -1 * keyboardVisibleHeight
-  })
-  .addDisposableTo(disposeBag)
-```
-    
-> **Note**: In real world, you should use `setNeedsLayout` and `layoutIfNeeded`. See the [demo project](https://github.com/devxoul/RxKeyboard/blob/master/Demo/Sources/ViewControllers/ViewController.swift#L62-L70) for example.
+- <a name="tip-content-inset" href="#tip-content-inset">🔗</a> **I want to adjust `UIScrollView`'s `contentInset` to fit keyboard height.**
+
+    ```swift
+    RxKeyboard.instance.visibleHeight
+      .drive(onNext: { keyboardVisibleHeight in
+        scrollView.contentInset.bottom = keyboardVisibleHeight
+      })
+      .addDisposableTo(disposeBag)
+    ```
+
+- <a name="tip-toolbar" href="#tip-toolbar">🔗</a> **I want to make `UIToolbar` move along with the keyboard in an interactive dismiss mode. (Just like the wonderful GIF above!)**
+
+    If you're not using Auto Layout:
+
+    ```swift
+    RxKeyboard.instance.visibleHeight
+      .drive(onNext: { keyboardVisibleHeight in
+        toolbar.frame.origin.y = self.view.height - toolbar.frame.height - keyboardVisibleHeight
+      })
+      .addDisposableTo(disposeBag)
+    ```
+
+    If you're using Auto Layout, you have to capture the toolbar's bottom constraint and set `constant` to keyboard visible height.
+
+    ```swift
+    RxKeyboard.instance.visibleHeight
+      .drive(onNext: { keyboardVisibleHeight in
+        toolbarBottomConstraint.constant = -1 * keyboardVisibleHeight
+      })
+      .addDisposableTo(disposeBag)
+    ```
+
+    > **Note**: In real world, you should use `setNeedsLayout()` and `layoutIfNeeded()` with animation block. See the [demo project](https://github.com/devxoul/RxKeyboard/blob/master/Demo/Sources/ViewControllers/ViewController.swift#L62-L70) for example.
+
+- Anything else? Please open an issue or make a Pull Request.
 
 ## Dependencies
 

Sources/RxKeyboard.swift

@@ -11,13 +11,19 @@ import UIKit
 import RxCocoa
 import RxSwift
 
+/// RxKeyboard provides a reactive way of observing keyboard frame changes.
 public class RxKeyboard: NSObject {
 
   // MARK: Public
 
+  /// Get a singleton instance.
   public static let instance = RxKeyboard()
 
+  /// An observable keyboard frame.
   public let frame: Driver<CGRect>
+
+  /// An observable visible height of keyboard. Emits keyboard height if the keyboard is visible
+  /// or `0` if the keyboard is not visible.
   public let visibleHeight: Driver<CGFloat>