From 2536a322f173ff19d4daaaaf4da0134ba8de21c7 Mon Sep 17 00:00:00 2001
From: Tawa Nicolas <tawanicolas@gmail.com>
Date: Sun, 2 Jul 2017 22:55:25 -0500
Subject: [PATCH] Update README.md

---
 README.md | 89 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 88 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1ec7345..0dc4c29 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,89 @@
 # TNTutorialManager
-Tutorial Handler that helps you implement interactive tutorials inside your iOS Apps.
+
+## Summary
+TNTutorialManager is an easy to implement library that helps you create interactive tutorials inside your iOS Apps!
+
+![](https://giant.gfycat.com/AstonishingDimpledGraywolf.gif)
+
+## Installation
+
+#### Manual install
+Download the folder 'TNTutorialManager' and add the files to your project.
+> Objective-C only
+
+#### Coacoapods
+Add the following line to your Podfile
+```ruby
+pod 'TNTutorialManager'
+```
+> The pod supports both Objective-C and Swift
+
+## Integration
+In order to add a tutorial for your specific ViewController all you need to do is `#import <TNTutorialManager.h>`, make your ViewController conform to the protocol `TNTutorialManagerDelegate`, and implement the following required methods:
+#### Objective-c
+```objective-c
+-(UIView *)tutorialMasterView;
+-(void)tutorialWrapUp;
+-(NSInteger)tutorialMaxIndex;
+```
+#### Swift
+```swift
+func tutorialMasterView() -> UIView!
+func tutorialWrapUp()
+func tutorialMaxIndex() -> Int
+```
+
+The method `tutorialMasterView` should return the UIView that will add the tutorial view as a subview.
+The method `tutorialWrapUp` should do the code that takes care of ending the tutorial, like setting the `tutorialManager` to nil and re-enabling UserInteraction.
+The method `tutorialMaxIndex` should return how many steps the tutorial have.
+
+The other optional methods will help you easily make an interactive tutorial:
+```objective-c
+/**
+ Perform actions for a tutorial step, example: Tap a certain button.
+ */
+-(void)tutorialPerformAction:(NSInteger)index;
+
+/**
+ Actions that need to be done before the highlight is done. Example, scroll to a certain UITableViewCell.
+ */
+-(void)tutorialPreHighlightAction:(NSInteger)index;
+
+/**
+ This optional method should return the delay in seconds that the tutorialManager should wait before performing the next highlight, it is used in case there's a UI update that needs to be done.
+ */
+-(CGFloat)tutorialPreActionDelay:(NSUInteger)index;
+
+/**
+ This optional method should return NO in case the tutorial shouldn't update for a certain index. Example: If the UI pushes a new UIViewController and you need to start a new tutorial from inside the new UIViewController.
+ */
+-(BOOL)tutorialWaitAfterAction:(NSInteger)index;
+
+/**
+ Methods used for building Tutorial UI.
+ */
+-(NSArray <UIView *> *)tutorialViewsToHighlight:(NSInteger)index;
+-(NSArray <NSString *> *)tutorialTexts:(NSInteger)index;
+-(NSArray <TNTutorialEdgeInsets *> *)tutorialViewsEdgeInsets:(NSInteger)index;
+-(NSArray <NSNumber *> *)tutorialTextPositions:(NSInteger)index;
+-(NSArray <UIFont *> *)tutorialTextsFont:(NSInteger)index;
+
+// Implement this method in case you wish to force the user to go through tutorial.
+-(BOOL)tutorialHasSkipButton:(NSInteger)index;
+
+// Default values are "Next" and "Skip". Implement those methods in case you wish to Localize your application or use different titles.
+-(UIFont *)tutorialSkipButtonFont;
+-(NSString *)tutorialSkipButtonTitle;
+
+// Default value is [UIColor whiteColor].
+-(UIColor *)tutorialButtonsColor;
+
+// Identifier used in NSUserDefaults to save the progress of the tutorial for the specific view controllers. The default value is the class name of the delegate. Implement only in case the same UIViewController class will be used multiple times in your UI and need a different identifier for each time it is used.
+-(NSString *)tutorialIdentifier;
+```
+
+The repository comes with a sample project that gives you an example of how to implement different capabilities of the manager.
+
+## Notes
+
+Feel free to use 'TNKeyboardControlWindow' in any way you like. An attribution is not required, but is highly appreciated.