Update documentation and set version to 1.7.12

Author: Luc Dion

CHANGELOG.md

@@ -7,6 +7,20 @@
 
 # Change Log
 
+## [1.7.12](https://github.com/layoutBox/PinLayout/releases/tag/1.7.12)
+Released on 2018-08-16
+
+#### Add Animations documentation and example
+Add documentation that explains how PinLayout can handle view's animations.
+
+* Show few strategies that can be used to animate views.
+* Add an Animation example in the Example app.
+* Add an new "Examples" markdown page showing all PinLayout's examples.
+* Convert `fileprivate` to `private` declarations
+
+* Added by [Luc Dion](https://github.com/lucdion) in Pull Request [#165](https://github.com/layoutBox/PinLayout/pull/165) 
+
+
 ## [1.7.11](https://github.com/layoutBox/PinLayout/releases/tag/1.7.11)
 Released on 2018-08-05
 

PinLayout.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |spec|
   spec.name          = "PinLayout"
-  spec.version       = "1.7.11"
+  spec.version       = "1.7.12"
   spec.summary       = "Fast Swift Views layouting without auto layout. No magic, pure code, full control and blazing fast. Concise syntax, intuitive, readable & chainable. [iOS/macOS/tvOS/CALayer]"
   spec.description   = "Fast Swift Views layouting without auto layout. No magic, pure code, full control and blazing fast. Concise syntax, intuitive, readable & chainable. [iOS/macOS/tvOS/CALayer]"
   spec.homepage      = "https://github.com/layoutBox/PinLayout"

README.md

@@ -162,7 +162,7 @@ This example shows how easily PinLayout can adjust its layout based on the view'
 * Full control: You're in the middle of the layout process, no magic black box. 
 * Layout one view at a time. Make it simple to code and debug.
 * Concise syntax. Layout most views using a single line. 
-* [See the complete list here....](docs/PinLayout_principles.md)
+* [**See the complete list here....**](docs/PinLayout_principles.md)
 
 <a name="performance"></a>
 # PinLayout's Performance 
@@ -171,7 +171,7 @@ PinLayout's performance has been measured using the [Layout Framework Benchmark]
 
 As you can see in the following chart, PinLayout are faster or equal to manual layouting, and **between 8x and 12x faster than auto layout**, and this for all types of iPhone (5S/6/6S/7/8/X)
 
-[See here for more details, results and explanation of the benchmark](docs/Benchmark.md).
+#### [See here for more details, results and explanation of the benchmark](docs/Benchmark.md).
 
 <p align="center">
 	<a href="docs/Benchmark.md">
@@ -194,7 +194,7 @@ PinLayout support macOS 10.9+.
 
 ### Right to left languages (RTL) support 
 PinLayout supports left-to-right (LTR) and right-to-left (RTL) languages. 
-[See here for more details](docs/rtl_support.md).
+#### [See here for more details](docs/rtl_support.md).
 
 <br/>
 
@@ -1488,7 +1488,7 @@ Warnings can be disabled also in debug mode by setting the boolean Pin.logWarnin
 
 PinLayout can easily animates Views. Multiple strategies can be used to animate layout using PinLayout.
 
-[See the section Animations using PinLayout for more details](docs/animations.md)
+#### [See the section Animations using PinLayout for more details](docs/animations.md)
 
 The following animation example is available in the [Examples App](#examples_app).
 
@@ -1574,12 +1574,28 @@ github "layoutBox/PinLayout"
 
 Then, run `carthage update` to build the framework and drag the built `PinLayout.framework` into your Xcode project.
 
+<br>
 
 <a name="examples_app"></a>
 ## Examples App 
 
 The PinLayout's Example App exposes some usage example of PinLayout.   
-[See the Example App section to get more information](docs_markdown/examples.md).
+
+#### [See the Example App section to get more information](docs_markdown/examples.md)
+
+Included examples:
+
+* The [introduction example](#intro_usage_example) presented previously in this README.	
+* Example using a UITableView with variable height cells.
+* Example using a UICollectionView with variable height cells.
+* Example showing how to animate with PinLayout.
+* Example using [`UIView.pin.safeArea`](#safeAreaInsets)
+* Example using [`wrapContent()`](#wrapContent)
+* Example showing right-to-left (RTL) language support.
+* Example showing a simple form example	
+* Example showing Relative Edges layout.
+* Example using Objective-C	
+* ...
 
 :pushpin: Tap on images to see the example's source code.
 
@@ -1643,15 +1659,15 @@ bLayer.pin.below(of: aLayer, aligned: .left).size(of: aLayer)
 
 PinLayout layouts views immediately after the line containing `.pin` has been fully executed, thanks to ARC (Automatic Reference Counting) this works perfectly on iOS/tvOS/macOS simulators and devices. But in Xcode Playgrounds, ARC doesn't work as expected, object references are kept much longer. This is a well documented issue and have a little impact on the PinLayout behaviour.
 
-[See here for more details about using PinLayout in Xcode playgrounds](docs/xcode_playground.md)
+#### [See here for more details about using PinLayout in Xcode playgrounds](docs/xcode_playground.md)
 
 <br>
 
 <a name="objective_c_interface"></a>
 ## PinLayout using Objective-C 
 PinLayout also expose an Objective-C interface slightly different than the Swift interface. 
 
-[See here for more details](docs/objective_c.md)
+#### [See here for more details](docs/objective_c.md)
 
 <br>
 

docs/Example.md

@@ -17,32 +17,42 @@ The Example App is available in the [`Example`](https://github.com/layoutBox/Pin
 </br>
 
 ## Intro Example
-PinLayout introduction example.  
+PinLayout introduction example presented in the README.
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/Intro/IntroView.swift)
 
 <img src="images/pinlayout_intro_example_iphonex.png" width=420/>
 
 ## Relative Edges Layout Example 
+Example showing how to layout views relative to other views.
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/RelativeView/RelativeView.swift)
 
 <img src="pinlayout_exampleapp_relative_position.png" width=180/>
 
 ## Multi Relative Edges Layout Example
+Example showing how to layout a view relative to many other views.
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/MultiRelativeView)
 
 <img src="pinlayout_exampleapp_multi_relative_position.png" width=180/>
 
 ## UITableView Example
+Example using a UITableView with variable height cells.
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/TableViewExample/TableViewExampleView.swift)
 
 <img src="pinlayout_exampleapp_tableview.png" width=180/>
 
 ## UICollectionView Example
+Example using a UICollectionView with variable height cells.
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/CollectionViewExample/HouseCell.swift)
 
 <img src="pinlayout_exampleapp_collectionview.png" width=180/>
 
 ## Animations Example
+Example showing how to animate views with PinLayout.
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/Animations/AnimationsView.swift)
 
 <img src="images/example-animations.gif" width=180/>
@@ -56,26 +66,41 @@ This example show how PinLayout can support simultaneously Left to right and rig
 
 
 ## pin.safeArea example
+Example showing the usage of `UIView.pin.safeArea`] with UINavigationController and UITabViewController.
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/SafeArea/SafeAreaView.swift)
 
 <img src="images/pinlayout_safearea_example_iphonex.png" width=420/>
+<img src="images/pinlayout_safearea_2_example_iphonex.png" width=420/>
+
 
 ## Adjust To Container Example
+Example showing how PinLayout can be used to adjust the layout depending of the space available.
+
+In this example the UISegmentedControl is shown below its label if the available width is smaller than 500 pixels, or on the same line as the label if the width is wider.
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/AdjustToContainer/Subviews/ChoiceSelectorView.swift")
 
-<img src="pinlayout_example_adjust_to_container-portrait.png" width=180/>
+<img src="pinlayout_example_adjust_to_container2.png" width=420/>
+
 
 ## wrapContent Example
+This example show how to use the `wrapContent()` method. This method is particularly useful to wrap a group of views and center them.
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/WrapContent/WrapContentView.swift)
 
 <img src="pinlayout_example_wrapContent.png" width=180/>
 
 ## Form Example
+This example is a basic form containing 4 fields. 
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/Form/FormView.swift)
 
 <img src="pinlayout_example_form.gif" width=180/>
 
 ## Auto Adjusting Size Example
+This example show how fixed size views and expandable views can be layouted using PinLayout to fill the available space.
+
 [Source code](https://github.com/layoutBox/PinLayout/blob/master/Example/PinLayoutSample/UI/Examples/AutoAdjustingSize/AutoAdjustingSizeView.swift)
 
 <img src="pinlayout_exampleapp_auto_adjusting_size.png" width=180/>