Merge pull request #74 from handsomecode/develop

Updating and refining README

Author: enmiller

.gitignore

@@ -17,6 +17,7 @@ DerivedData
 *.perspectivev3
 !default.perspectivev3
 xcuserdata
+*.orig
 
 ## Other
 *.xccheckout

README.md

@@ -1,21 +1,33 @@
-# Interactive Side Menu
-
-[![Swift version](https://img.shields.io/badge/swift-3.0-orange.svg?style=flat.svg)](https://img.shields.io/badge/swift-3.0-orange.svg?style=flat.svg)
-[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
-[![License](https://img.shields.io/hexpm/l/plug.svg)](./LICENSE)
+<p align="center">
+    <a href="https://github.com/handsomecode/InteractiveSideMenu">
+        <img src="Screenshots/InteractiveSideMenu.gif">
+    </a>
+</p>
+<p align="center">
+    <a href="https://swift.org/">
+        <img src="https://img.shields.io/badge/swift-3.0-orange.svg?style=flat.svg" alt="Swift version: 3.0">
+    </a>
+    <a href="https://cocoapods.org/pods/InteractiveSideMenu">
+        <img src="https://img.shields.io/badge/CocoaPods-2.1-green.svg" alt="CocoaPods: 2.1">
+    </a>
+    <a href="https://github.com/Carthage/Carthage">
+        <img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage compatible">
+    </a>
+    <a href="https://github.com/handsomecode/InteractiveSideMenu/blob/master/LICENSE">
+        <img src="https://img.shields.io/hexpm/l/plug.svg" alt="License: Apache 2.0">
+    </a>
+</p>
 
-iOS Interactive Side Menu written in Swift. 
-
-![sample](Screenshots/InteractiveSideMenu.gif)
+# Interactive Side Menu
+A customizable, interactive, auto expanding and collapsing side menu for iOS written in Swift.
 
-It supports following customization:
+Here are some of the ways Interactive Side Menu can be customized:
 - Animation duration
 - Visible content width
 - Content scale
-- Using spring animation with params customization
-- Animation options like animation curve
-
-All these parameters could vary for different orientations.
+- UIView spring animations
+- Animation curves
+- Customized animation settings for different orientations
 
 ## Communication
 
@@ -27,35 +39,33 @@ All these parameters could vary for different orientations.
 
 You can find more details into [CONTRIBUTING](./CONTRIBUTING.md) file.
 
-# Installation
+## Installation
 
-## CocoaPods
-To install it through [CocoaPods](https://cocoapods.org/), add the following line to your Podfile:
+### CocoaPods
+To install using [CocoaPods](https://cocoapods.org/), add the following line to your Podfile:
 ```
 pod 'InteractiveSideMenu'
 ```
 Please, don't forget to run `pod update` command to update your local specs repository during migration from one version to another.
 
-## Carthage
-To install it through [Carthage](https://github.com/Carthage/Carthage), add the following line to your Cartfile:
+### Carthage
+To install using [Carthage](https://github.com/Carthage/Carthage), add the following line to your Cartfile:
 ```
 github "handsomecode/InteractiveSideMenu"
 ```
 
+## Usage
+To implement your side menu you should subclasses the following view controllers: `MenuContainerViewController` and `MenuViewController`
+- `MenuContainerViewController` is the main container that hosts the side menu and content controller
+- `MenuViewController` is the container controller for the side menu
 
-# Usage
-To implement your side menu you should create subclasses of basic View Controllers.
-- ```MenuContainerViewController``` is a host for menu and content views
-- ```MenuViewController``` is a container for menu view
-
-Also, ensure that every menu item ViewController adopts relevant protocol.
-- ```SideMenuItemContent``` is a ViewController's protocol for data that corresponds menu item
+To add a new menu item, your view controller needs to conform to the `SideMenuItemContent` protocol.
 
-## HostViewController implementation
-To setup your side menu you need to do three things:
-- Provide implementation of base ```MenuViewController``` and assing it to  ```menuViewController``` property
-- Provide implementation of menu content and assing array of content controllers to ```contentViewControllers``` property
-- Select initial content controller by calling ```selectContentViewController(_ selectedContentVC: MenuItemContentViewController)```
+Setting up the side menu can be done in three steps:
+##### For this, Host = `MenuContainerViewController` subclass and Menu = `MenuViewController` subclass
+1. Assign Menu to the `menuViewController` property of Host
+2. Set the Host's `contentViewControllers` array with an array of `SideMenuItemContent` controllers
+3. Call `selectContentViewController(_ selectedContentVC: MenuItemContentViewController)` from Host
 
 ```swift
 import InteractiveSideMenu
@@ -79,7 +89,7 @@ class HostViewController: MenuContainerViewController {
 ```
 
 ## Items content
-To show menu, call ```showSideMenu()``` method from `SideMenuItemContent` protocol.
+To show menu, call `showSideMenu()` from any `SideMenuItemContent` controller.
 ```swift
 import InteractiveSideMenu
 
@@ -91,7 +101,7 @@ class KittyViewController: UIViewController, SideMenuItemContent {
 }
 ``` 
 
-To change content view, choose desired content controller and hide menu.
+To change the currently visible controller, pass the desired controller to your `MenuContainerViewController`:
 ```swift
     let index = 2 // Second menu item
     guard let menuContainerViewController = self.menuContainerViewController else { return }
@@ -119,7 +129,7 @@ class InnerViewController: UIViewController {
 Please, find UITabBarController implementation details in [Sample](./Sample).
 
 ## Animation Customization
-To customize animation for menu opening or closing, update ```transitionOptions``` property that is available in ```MenuContainerViewColtroller``` class. Initial setup could be done, for example, on controller's ```viewDidLoad()```.
+To customize the open and close animations, update the `transitionOptions` property on your `MenuContainerViewColtroller` subclass. The sample project does this in `viewDidLoad()`
  ```swift
 override func viewDidLoad() {
     super.viewDidLoad()
@@ -129,7 +139,7 @@ override func viewDidLoad() {
 }
 ```
 
-Also, you have possibility to update customization settings, e.g. set another options for landscape orientation. To do it, override ```viewWillTransition(to:with:)``` mehod and add desired parameters to ```transitionOptions``` property.
+To customize transition options for different orientations, override `viewWillTransition(to:with:)` and update the `transitionOptions`.  This can also be done with trait collections using `traitCollectionDidChange(_:)`
 ```swift
 override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {
     super.viewWillTransition(to: size, with: coordinator)
@@ -140,12 +150,10 @@ override func viewWillTransition(to size: CGSize, with coordinator: UIViewContro
 }
 ```
 
-Transition options could be used to set different parameters for Compact and Regular sizes as well. Implement ViewController's ```traitCollectionDidChange(_: )``` method to add these settings.
-
- Use [Sample](./Sample) to see implementation details and [CHANGELOG](./CHANGELOG.md) to get more information about updating library from v1.0 to v2.0.
+ Check out the [Sample](./Sample) project for more details and usage examples.
 
 # Known Issues
-There is [an issue](https://github.com/handsomecode/InteractiveSideMenu/issues/53) associated with scaling of NavigationBar in iOS 11. Status bar background is hidden during side menu closing if `contentScale < 1`. It’s supposed to be *iOS 11* Navigation Bar issue that's been reported to Apple.
+There is [an issue](https://github.com/handsomecode/InteractiveSideMenu/issues/53) associated with the scaling of a UINavigationBar in iOS 11. Status bar background is hidden during side menu closing if `contentScale < 1`.  This is an *iOS 11* issue and has been reported to Apple.
 
 
 # Requirements

Sources/MenuItemContentViewController.swift

@@ -1,5 +1,5 @@
 //
-// MenuItemContentViewController.swift
+// SideMenuItemContent.swift
 //
 // Copyright 2017 Handsome LLC
 //