Update README.md

Author: amirdew

README.md

@@ -6,13 +6,9 @@
 [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) 
 [![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)
 
-## Preview
+## Layout Designer
+<img width="600" src="https://amir.app/git/layout_designer_preview.gif"></img>
 
-<p float="left">
-<img width="200" src="https://amir.app/git/flowlayout_preview.gif"></img>
-<img width="200" src="https://amir.app/git/gallery_preview.gif"></img>
-<img width="200" src="https://amir.app/git/cards_preview.gif"></img>
-</p>
 
 ### SnapshotTransformView
 
@@ -50,10 +46,21 @@
 <img width="100" src="https://amir.app/git/shapes_preview/stack_vortex.gif"></img>
 </p>
 
+## Custom implementation
+
+<p float="left">
+<img width="100" src="https://amir.app/git/flowlayout_preview.gif"></img>
+<img width="100" src="https://amir.app/git/gallery_preview.gif"></img>
+<img width="100" src="https://amir.app/git/cards_preview.gif"></img>
+</p>
+
+
 ## About
-This is a custom `UICollectionViewLayout` that gives you the ability to apply transforms easily on the cells        
-by conforming your cell class to `TransformableView` protocol you will get a `progress` value and you can use it to apply any changes on your cell view.  
-See [How to use](https://github.com/amirdew/CollectionViewPagingLayout#how-to-use) part for more details.  
+CollectionViewPagingLayout is a simple but powerful tool for making complex layouts for your UICollectionView.
+The implementation is very simple there is custom `UICollectionViewLayout` that gives you the ability to apply transforms on the cells.
+No inheritance or anything like that.
+See [How to use](https://github.com/amirdew/CollectionViewPagingLayout#how-to-use) part for more details.
+
 
 ## Installation
 CollectionViewPagingLayout doesn't contain any external dependencies.
@@ -97,6 +104,19 @@ File > Swift Packages > Add Package Dependency
 Just add all the files under `Lib` directory to your project
 
 ## How to use
+
+### Using Layout Designer
+
+There is a macOS app to make it even easier for you to make your own custom layout.
+It allows you to tweak many options and see the result in real time. 
+- Clone the repository then build and run the mac app.
+- Tweak options and design your layout.
+- Copy the code from the right panel and paste it on Xcode, make sure to choose "ViewController" if you need the full implementation.
+- Don't forget to [install](https://github.com/amirdew/CollectionViewPagingLayout#installation) the libray
+
+
+### Manually
+
 - Make sure you imported the library
 ```swift
 import CollectionViewPagingLayout
@@ -110,9 +130,10 @@ collectionView.collectionViewLayout = layout
 collectionView.isPagingEnabled = true // enabling paging effect
 ```
 
-- Now you just need to conform your `UICollectionViewCell` class to `TransformableView` and start implementing your custom transforms.     
+- Now you just need to conform your `UICollectionViewCell` class to `TransformableView` and start implementing your custom transforms. By conforming your cell class to `TransformableView` protocol you will get a `progress` value and you can use it to apply any changes on your cell view.  
 
-*Note:* you can use [Prepared Transformable Protocols](#prepared-transformable-protocols) instead of `TransformableView` if you don't want a custom effect!        
+
+*Note:* you can use [Prepared Transformable Protocols](#prepared-transformable-protocols) instead of `TransformableView` if you want to use prepared effects!        
 
 ```swift
 extension MyCollectionViewCell: TransformableView {
@@ -209,26 +230,44 @@ to find the public function(s) for each tansformable check the protocol definiti
 
 ## Other features
 
-You can control the current page by following public functions of `CollectionViewPagingLayout`:
+### Control current page
+
+You can control the current page by the following functions of `CollectionViewPagingLayout`:
 - `func setCurrentPage(_ page: Int, animated: Bool = true)`
 - `func goToNextPage(animated: Bool = true)`
 - `func goToPreviousPage(animated: Bool = true)`       
 
 these are safe wrappers for setting `ContentOffset` of `UICollectionview`        
-you can also get current page by a public variable `CollectionViewPagingLayout.currentPage` or listen to the changes by setting `CollectionViewPagingLayout.delegate`:      
-
+you can also get current page by a public variable `CollectionViewPagingLayout.currentPage` or listen to changes by using `CollectionViewPagingLayout.delegate`:      
 ```swift
 public protocol CollectionViewPagingLayoutDelegate: class {
     func onCurrentPageChanged(layout: CollectionViewPagingLayout, currentPage: Int)
 }
 ```
 
+### Handle touches
+
+There is built-in solution for handling tap gestues on the views
+- Implement `TransformableView.selectableView` and pass the view that you would like to handle tap gestues for (by default this is the first subview of your `UICollectionViewCell.contentView`)
+- Call `CollectionViewPagingLayout.configureTapOnCollectionView()` after setting the layout for you collection view
+- Set the delegate for layout (`CollectionViewPagingLayout.delegate`)
+- Use didSelectItemAt function `func collectionViewPagingLayout(_ layout: CollectionViewPagingLayout, didSelectItemAt indexPath: IndexPath)`
+
 
 ## Limitations
+-  Specify the number of visible cells:
 You need to specify the number of visible cells since this layout gives you the flexibility to show the next and previous cells.   
 By default, the layout loads all of the cells in the collection view frame and that means it keeps all of them in memory.
 You can specify the number of cells that you need to show at a time by considering your design.
 
+- Touches on cells:
+The way that this layout works is putting all the cells in the collectionview frame (doesn't matter which TransformView you use)
+and then it applies transforms on the target view (StackTransformView.cardView, ScaleTransformView.scalableView etc)
+so you can use `func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath)` but only for one cell at the same time
+you can implement `func zPosition(progress: CGFloat) -> Int` to specify wich cell should be on top
+
+if you would like to handle tap on multiple cells at the same time see [Handle touches]()
+
 
 ## License