Merge pull request #40 from jeantimex/update-documentation-for-release

Updated document for release.

Author: jeantimex

CollapsibleTableSectionViewController.podspec

@@ -16,7 +16,7 @@ Pod::Spec.new do |s|
   #
 
   s.name         = "CollapsibleTableSectionViewController"
-  s.version      = "0.0.9"
+  s.version      = "1.0.0"
   s.summary      = "Swift 3.0 library to support collapsible sections in a table view."
 
   # This description is used to generate tags and improve search results.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Su
+Copyright (c) 2017 Yong Su @jeantimex
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -12,21 +12,13 @@ Swift library to support collapsible sections in a table view.
 
 ![cover](docs/images/cover.gif)
 
-## When can I use this pod?
+## Features
 
-This CocoaPod is still under development. 
-
-#### Release Roadmap
-- [x] Cocoa framework development folder structure
-- [x] Add travis CI for unit testing
-- [x] Wrap the collapsible table view in a UIViewController to hide the implementation of collapsing table sections
-- [x] Basic interface design, the goal is make this library easy to use and extend for more features in the future
-- [x] Add test cases, test, test and test
-- [x] Add several examples in the Examples project
-- [ ] Complete the documentation
-- [ ] Release
-
-Can't wait to use it? Please checkout this repo for the implementation: https://github.com/jeantimex/ios-swift-collapsible-table-section.
+- Support collapsible sections in a table view
+- Collapse all the sections by default (configurable)
+- Keep only one section expanded (configurable)
+- Auto resize table view cell
+- Easy-to-use protocols for configuration
 
 ## Requirements
 
@@ -50,7 +42,7 @@ Just clone and add the following Swift files to your project:
 - `nano Podfile`, add:
 ```
 use_frameworks! 
-pod 'CollapsibleTableSectionViewController', :git => 'https://github.com/jeantimex/CollapsibleTableSectionViewController.git'
+pod 'CollapsibleTableSectionViewController', '~> 1.0.0'
 ``` 
 - Save it: `ctrl-x`, `y`, `enter`
 - `pod update`
@@ -60,7 +52,7 @@ pod 'CollapsibleTableSectionViewController', :git => 'https://github.com/jeantim
 ### Carthage
 
 * `nano Cartfile`
-* put `github "jeantimex/CollapsibleTableSectionViewController" "master"` into Cartfile
+* put `github "jeantimex/CollapsibleTableSectionViewController" ~> 1.0.0` into Cartfile
 * Save it: `ctrl-x`, `y`, `enter`
 * Run `carthage update`
 * Copy `CollapsibleTableSectionViewController.framework` from `Carthage/Build/iOS` to your project
@@ -83,11 +75,11 @@ class ViewController: CollapsibleTableSectionViewController { ... }
 extension ViewController: CollapsibleTableSectionDelegate { ... }
 ```
 
-Most of the protocol methods are very similar to `UITableViewDataSource` and `UITableViewDelegate`, if you know how to use them in `UITableViewController`, then you will find our protocol methods easy to use.
+## CollapsibleTableSectionDelegate Protocols
 
-Here is a list of the available protocol methods:
+Most of the protocol methods are optional and they are very similar to `UITableViewDataSource` and `UITableViewDelegate`, here is a list of the available protocol methods:
 
-1. `optional func numberOfSections(_ tableView: UITableView) -> Int`<br />
+#### 1. optional func numberOfSections(_ tableView: UITableView) -> Int
 Asks the data source to return the number of sections in the table view. Default is `1`.
 
 ```swift
@@ -98,7 +90,7 @@ extension ViewController: CollapsibleTableSectionDelegate {
 }
 ```
 
-2. `optional func collapsibleTableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int`<br />
+#### 2. optional func collapsibleTableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int
 Returns the number of rows (table cells) in a specified section. Default is `0`.
 
 ```swift
@@ -109,7 +101,8 @@ extension ViewController: CollapsibleTableSectionDelegate {
 }
 ```
 
-3. `optional func collapsibleTableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell`<br />
+#### 3. optional func collapsibleTableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell
+
 Returns the table cell at the specified index path. You can also use your custom cells, see our example projects for more details.
 
 ```swift
@@ -122,24 +115,61 @@ extension ViewController: CollapsibleTableSectionDelegate {
 }
 ```
 
-4. `optional func shouldCollapseByDefault(_ tableView: UITableView) -> Bool`<br />
+#### 4. optional func shouldCollapseByDefault(_ tableView: UITableView) -> Bool
+
 Return `true` if you would like collapse all the sections when the table is loaded. Default is `false`.
 
-5. `optional func shouldCollapseOthers(_ tableView: UITableView) -> Bool`<br />
+#### 5. optional func shouldCollapseOthers(_ tableView: UITableView) -> Bool
+
 Return `true` if you would like to keep only one extended section (like accordion style). Default is `false`.
 
-6. `optional func collapsibleTableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String?`<br />
+#### 6. optional func collapsibleTableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String?
+
 The title for each section. Default is `nil`.
 
-7. `optional func collapsibleTableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath)`<br />
+#### 7. optional func collapsibleTableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath)
+
 Tells the delegate that the specified row is now selected.
 
+## Examples
+
+Run the Examples project in this repo and you will find the following demos that help you get up and running:
+
+1. Basic: The minimal working example
+2. Custom Cell: Implement a custom cell programmatically
+3. Collapse By Default: All sections are collapsed by default
+4. Collapse Others: Accordion-style table view that only keeps one section expanded at a time
+
+For more details of how to implement collapsible table sections using Swift, please checkout this repo for more information: https://github.com/jeantimex/ios-swift-collapsible-table-section.
+
 ## Contribution
 
-You are welcome to fork and submit pull requests
+Anyone who would like to contribute to the project is more than welcome.
+
+* Fork this repo
+* Make your changes
+* Submit pull request
 
 ## License
 
-This project is licensed under the MIT license, Copyright (c) 2017 Yong Su. For more information see `LICENSE.md`.
+MIT License
+
+Copyright (c) 2017 Yong Su @jeantimex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-Author: [Yong Su](https://github.com/jeantimex) @ Box Inc.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.