Merge branch 'master' of https://github.com/jnblanchard/JNBBottombar

README.md

@@ -5,12 +5,12 @@
 [![License](https://img.shields.io/cocoapods/l/JNBBottombar.svg?style=flat)](https://cocoapods.org/pods/JNBBottombar)
 [![Platform](https://img.shields.io/cocoapods/p/JNBBottombar.svg?style=flat)](https://cocoapods.org/pods/JNBBottombar)
 
-## Example
-
-To run the example project, clone the repo, and run `pod install` from the Example directory first.
+![](https://static.wixstatic.com/media/8e69fb_e74803bfa5144e44bc429689a8d67465~mv2.gif)
 
 ## Requirements
 
+iOS 11+
+
 ## Installation
 
 JNBBottombar is available through [CocoaPods](https://cocoapods.org). To install
@@ -20,10 +20,35 @@ it, simply add the following line to your Podfile:
 pod 'JNBBottombar'
 ```
 
-## Author
+## Example
 
-jnblanchard@mac.com, jnblanchard@mac.com
+Here's how one may show a greeting label for two and a half seconds.
+```swift
+JNBBottombar.shared.showWith(contentView: label,
+                             contentBackgroundColor: UIColor.black,
+                             cornerRadius: 6,
+                             screenInsets: UIEdgeInsets(top: 0, left: -8, bottom: -16, right: -8),
+                             shadowColor: UIColor.black.cgColor,
+                             shadowOpacity: 0.7,
+                             shadowRadius: 10,
+                             borderWidth: 2.0,
+                             borderColor: UIColor.white.cgColor,
+                             forDuration: 2.5,
+                             completion: nil)
+```
+
+If you do not specify a forDuration; the bar will show until hide or another call to show is made.
+```swift
+JNBBottombar.shared.hide { (completed) in
+  guard completed else { return }
+  // bar has finished animating down
+}
+```
 
 ## License
 
-JNBBottombar is available under the MIT license. See the LICENSE file for more info.
+MIT license. See the LICENSE file for more info.
+
+## Author
+
+jnblanchard@mac.com