Back merging with master to get missing documentation files

Author: Eric Miller

.gitignore

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

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at mobile@handsome.is. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,97 @@
+# Contributing to InteractiveSideMenu
+
+:+1: First of all, big thanks for your desire to contribute in this project :+1:
+
+## How to contribute
+
+The easiest way to contribute is to *report a bug* or *propose a new feature* using [GitHub Issues](https://github.com/handsomecode/InteractiveSideMenu/issues).
+Also, feel free to send your suggestions concerning any library issues, documentation and README typos, [Sample](./Sample) improvements, or any other enhancements. **We really appreciate your participation!**
+
+### How to ask a question
+
+Before asking a question, please look through the [README](./README.md) and [Sample application](./Sample) or take a look into [already asked GitHub Issues](https://github.com/handsomecode/InteractiveSideMenu/issues) (even closed). If you still haven't found an answer, feel free to [open an issue](https://github.com/handsomecode/InteractiveSideMenu/issues/new) and ask us your question and mark it with the prepared `question` label.
+
+### How to report a bug
+
+The standard way to report a bug is [GitHub Issues](https://github.com/handsomecode/InteractiveSideMenu/issues).
+
+Explain the problem and include additional details to help maintainers reproduce the problem:
+
+- **Use a clear and descriptive title** for the issue to identify the problem.
+- **Describe the exact steps to reproduce the problem** in as many details as possible.
+- **Provide specific examples** to demonstrate these steps. Include links to files or GitHub projects, or copy/paste snippets. If you're providing snippets in the issue, use Markdown code blocks.
+- **Describe the behavior you observed** after following these steps and point out what exactly is the problem with that behavior.
+- **Explain the behavior you expected** to see instead and why.
+- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
+- **If you're reporting a library crash**, include a crash report with a stack trace.
+
+Include details about your configuration and environment:
+
+- **Which version of InteractiveSideMenu** are you using?
+- Do you test on the **Simulator** or a **Real device**?
+- **iOS version** that you test with.
+- **Xcode version** if it could be helpful in your case.
+
+### How to request an enhancement
+
+**Enhancements** are features that you might like to suggest to a project, but aren't necessarily bugs/problems with the existing code. There is *a label* for enhancements in [Github's Issues](https://github.com/handsomecode/InteractiveSideMenu/issues), so you can tag issues as `enhancement`, and thereby allow us to prioritize issues/bugs reported to the project.
+
+
+### How to tell us about your application
+
+If you are using **InteractiveSideMenu** in your project that is successfully published to AppStore, [send the link](https://github.com/handsomecode/InteractiveSideMenu/issues/new) to us and we'll add you to the list of applications that use the library.
+
+
+### How to submit changes
+
+When contributing to this repository, please, first discuss the change you wish to make via [issue](https://github.com/handsomecode/InteractiveSideMenu/issues/new).
+The preferred workflow for contributing to InteractiveSideMenu is to fork the [main repository](https://github.com/handsomecode/InteractiveSideMenu) on
+GitHub, clone, and develop on a branch.
+
+**Steps:**
+
+1. Fork the [project repository](https://github.com/handsomecode/InteractiveSideMenu)
+   by clicking on the 'Fork' button near the top right of the page. This creates
+   a copy of the code under your GitHub user account. For more details on
+   how to fork a repository see [this guide](https://help.github.com/articles/fork-a-repo/).
+
+2. Clone your fork of the *InteractiveSideMenu* repo from your GitHub account to your local disk
+
+   ```bash
+   $ git clone git@github.com:YourLogin/InteractiveSideMenu.git
+   $ cd InteractiveSideMenu
+   ```
+
+3. Checkout to `develop` branch, and create a ``feature`` branch to hold your development changes
+
+   ```bash
+   $ git checkout develop
+   $ git checkout -b feature/my_updates
+   ```
+
+   Always use a ``feature`` branch. It's good practice to add updates to the main branches.
+
+4. Develop the feature on your feature branch. Add changed files using ``git add`` and then ``git commit`` files
+
+   ```bash
+   $ git add modified_files
+   $ git commit
+   ```
+
+   to record your changes in Git, then push the changes to your GitHub account with
+
+   ```bash
+   $ git push -u origin feature/my_updates
+   ```
+
+5. Add your updates to [Sample](./Sample) as well. Also, don't forget to update [README](./README.md) and [CHANGELOG](./CHANGELOG.md) with your changes.
+
+6. Follow [these instructions](https://help.github.com/articles/creating-a-pull-request-from-a-fork)
+to create a pull request from your fork. This will send an email to the committers.
+
+(If any of the above seems like magic to you, please look up the
+[Git documentation](https://git-scm.com/documentation) on the web, or ask a friend or another contributor for help)
+
+## Code of Conduct
+
+This project is governed by the [CODE OF CONDUCT](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please, report unacceptable behavior to mobile@handsome.is.

InteractiveSideMenu.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "InteractiveSideMenu"
-  s.version      = "2.0"
+  s.version      = "2.1"
   s.summary      = "Interactive Side Menu in Swift"
   s.homepage     = "https://github.com/handsomecode/InteractiveSideMenu"
   s.license      = "Apache 2.0 license"

README.md

@@ -29,13 +29,24 @@ Here are some of the ways Interactive Side Menu can be customized:
 - Animation curves
 - Customized animation settings for different orientations
 
+## Communication
+
+- If you **need help or found a bug**, please, open an issue.
+- If you **have a feature request**, open an issue.
+- If you **are ready to contribute**, submit a pull request.
+- If you **like Interactive Side Menu**, please, give it a star.
+- If you **use Interactive Side Menu in your application published to AppStore**, [send us a link](https://github.com/handsomecode/InteractiveSideMenu/issues/new) and we'll create the list with applications used our library.
+
+You can find more details into [CONTRIBUTING](./CONTRIBUTING.md) file.
+
 ## Installation
 
 ### 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 using [Carthage](https://github.com/Carthage/Carthage), add the following line to your Cartfile:
@@ -77,6 +88,7 @@ class HostViewController: MenuContainerViewController {
 }
 ```
 
+## Items content
 To show menu, call `showSideMenu()` from any `SideMenuItemContent` controller.
 ```swift
 import InteractiveSideMenu
@@ -91,13 +103,32 @@ class KittyViewController: UIViewController, SideMenuItemContent {
 
 To change the currently visible controller, pass the desired controller to your `MenuContainerViewController`:
 ```swift
-    let index = 2 // second menu item
+    let index = 2 // Second menu item
     guard let menuContainerViewController = self.menuContainerViewController else { return }
     let contentController = menuContainerViewController.contentViewControllers[index]
     menuContainerViewController.selectContentViewController(contentController)
-    menuContainerViewController.hideMenu()
+    menuContainerViewController.hideSideMenu()
  ```
+ 
+### TabBar and Navigation controllers
+
+To use menu with **TabBar** or **NavigationController**, ensure that you indicate UITabBarController or UINavigationController as item content directly, not any corresponding ViewControllers.
+```swift
+class NavigationViewController: UINavigationController, SideMenuItemContent {
+}
+
+class InnerViewController: UIViewController {
 
+    @IBAction func openMenu(_ sender: Any) {
+        if let navigationViewController = self.navigationController as? SideMenuItemContent {
+            navigationViewController.showSideMenu()
+        }
+    }
+}
+```
+Please, find UITabBarController implementation details in [Sample](./Sample).
+ 
+## Animation Customization
 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() {