Update README.md

README.md

@@ -1,4 +1,127 @@
 MGSwipeTableCell
 ================
 
-An easy to use UITableViewCell subclass that allows to display swippable buttons with a variety of transitions.
+
+MGSwipeTableCell is an easy to use UITableViewCell subclass that allows to display swippable buttons with a variety of transitions. 
+
+
+This library is compatible with all the different ways to create a UITableViewCell: system predefined styles, programmatically created cells, cells loaded from a xib and prototype cells within a storyboard. You can use autolayout if you want.
+
+Works on iOS >= 5.0. Tested on all iOS versions on iPhone and iPad: iOS 5, iOS 6, iOS 7 and iOS 8.
+
+##Transitions demo
+
+###Border transition
+
+<p align="center"><img src="https://raw.githubusercontent.com/MortimerGoro/MGSwipeTableCell/master/readme-assets/border.gif" /></p>
+
+###Clip transition
+
+<p align="center"><img src="https://raw.githubusercontent.com/MortimerGoro/MGSwipeTableCell/master/readme-assets/clip.gif" /></p>
+
+###3D transition
+
+<p align="center"><img src="https://raw.githubusercontent.com/MortimerGoro/MGSwipeTableCell/master/readme-assets/3d.gif" /></p>
+
+###Static transition
+
+<p align="center"><img src="https://raw.githubusercontent.com/MortimerGoro/MGSwipeTableCell/master/readme-assets/static.gif" /></p>
+
+###Drag transition
+
+<p align="center"><img src="https://raw.githubusercontent.com/MortimerGoro/MGSwipeTableCell/master/readme-assets/drag.gif" /></p>
+
+## API Reference
+See [`MGSwipeTableCell.h`](MGSwipeTableCell/MGSwipeTableCell.h) header file for a complete overview of the capabilities of the class.
+
+See [`MGSwipeDemo`](demo) for a complete project where you can test the variety of transitions on a real device/simulator.
+
+##Usage
+
+###Basic 
+Integrating MGSwipeTableCell in your project is veary easy. Basically, you only have to inherit from MGSwipeTableCell instead of UITableViewCell, or directly instantiate MGSwipeTableCell instances with iOS predefined cell styles. You can layout your cell content as you are used to do, MGSwipeTableCell doesn't force you to change layouts.
+
+Here is a example of a MGSwipeTableCell using iOS predefined styles. You can set an array of buttons to cell.leftButtons and/or cell.rightButtons properties. MGSwipeButton is a convenience class, you are not force to use it. You can use your own UIButtons or UIViews. You can configure transitions (and swipe thresholds) with the leftSwipeSettings and/or rightSwipeSettings properties
+
+```objc
+- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
+{
+    static NSString * reuseIdentifier = @"programmaticCell";
+    MGSwipeTableCell * cell = [self.tableView dequeueReusableCellWithIdentifier:reuseIdentifier];
+    if (!cell) {
+        cell = [[MGSwipeTableCell alloc] initWithStyle:UITableViewCellStyleSubtitle reuseIdentifier:reuseIdentifier];
+    }
+
+    cell.textLabel.text = @"Title";
+    cell.detailTextLabel.text = @"Detail text";
+    cell.delegate = self; //optional
+
+
+    //configure left buttons
+    cell.leftButtons = @[[MGSwipeButton buttonWithTitle:@"" icon:[UIImage imageNamed:@"check.png"] backgroundColor:[UIColor greenColor]],
+                          [MGSwipeButton buttonWithTitle:@"" icon:[UIImage imageNamed:@"fav.png"] backgroundColor:[UIColor blueColor]]];
+    cell.leftSwipeSettings.transition = MGSwipeTransition3D;
+
+    //configure right buttons
+    cell.rightButtons = @[[MGSwipeButton buttonWithTitle:@"Delete" backgroundColor:[UIColor redColor]],
+                           [MGSwipeButton buttonWithTitle:@"More" backgroundColor:[UIColor lightGrayColor]]];
+    cell.rightSwipeSettings.transition = MGSwipeTransition3D;
+    return cell;
+}
+```
+
+In order to listen button click events you have 2 options. You can implement the optional MGSwipeTableCellDelegate. If you are lazy to do that MGSwipeButton class comes with a convenience block callback ;)
+
+```objc
+[MGSwipeButton buttonWithTitle:@"More" backgroundColor:[UIColor lightGrayColor] callback:^BOOL(MGSwipeTableCell *sender) {
+      NSLog(@"Convenience callback for swipe buttons!");
+}]
+```
+
+###Delegate
+
+MGSwipeTableCellDelegate is an ptional delegate to configure swipe buttons or to receive triggered actions or another events. Buttons can be configured inline when the cell is created instead of using this delegate, but using the delegate improves memory usage because buttons are only created in demand.
+
+```objc
+@protocol MGSwipeTableCellDelegate <NSObject>
+
+@optional
+/**
+ * Delegate method to enable/disable swipe gestures
+ * @return YES if swipe is allowed
+ **/
+-(BOOL) swipeTableCell:(MGSwipeTableCell*) cell canSwipe:(MGSwipeDirection) direction;
+/**
+ * Called when the user clicks a swipe button or when a expandable button is automatically triggered
+ * @return YES to autohide the current swipe buttons
+ **/
+-(BOOL) swipeTableCell:(MGSwipeTableCell*) cell tappedButtonAtIndex:(NSInteger) index direction:(MGSwipeDirection)direction fromExpansion:(BOOL) fromExpansion;
+/**
+ * Delegate method to setup the swipe buttons
+ * Buttons can be any kind of UIView but it's recommended to use the convenience MGSwipeButton class
+ * Setting up buttons with this delegate instead of using cell properties improves memory usage because buttons are only created in demand
+ * @return Buttons array
+ **/
+-(NSArray*) swipeTableCell:(MGSwipeTableCell*) cell swipeButtonsForDirection:(MGSwipeDirection)direction;
+
+@end
+```
+
+###Expandable buttons
+
+Buttons are not expandable by default. You can set up expandable buttons using cell.leftExpansion and cell.rightExpansion properties
+
+Expandable button events are triggered automatically when the user ends the swipe gesture and the expansion is active (configurable via threshold value). Triggered expandable buttons can bounce back to their initial position or fill the entire UITableViewCell, you can select the desired animation using fillOnTrigger property.
+
+```objc
+@interface MGSwipeExpansionSettings: NSObject
+/** index of the expandable button (in the left or right buttons arrays) */
+@property (nonatomic, assign) NSInteger buttonIndex;
+/** if true the button fills the cell on trigger, else it bounces back to its initial position */
+@property (nonatomic, assign) BOOL fillOnTrigger;
+/** Size proportional threshold to trigger the expansion button. Default value 1.5 */
+@property (nonatomic, assign) CGFloat threshold;
+@end
+```
+
+