Add guidelines for ObjectMapper/Argo/Himotoki

Author: dtvd

ArgoUsage.md

@@ -1 +1,49 @@
 ## How to use APIKit + Argo
+Example using APIKitExt to combine APIKit and Argo.
+Note that a complete example is available at [Argo Sample folder](https://github.com/DTVD/APIKitExt/tree/master/Example/Argo%20Sample).
+
+### Model (Argo)
+Our model file will follow normal Argo's guide.
+```swift
+struct Repo {
+    var id: Int
+    var fullName: String
+    var stargazersCount: Int
+}
+
+extension Repo: Decodable {
+    static func decode(_ j: JSON) -> Decoded<Repo> {
+        return curry(Repo.init)
+            <^> j <| "id"
+            <*> j <| "full_name"
+            <*> j <| "stargazers_count"
+    }
+}
+```
+
+### Defining request type (APIKit + APIKitExt)
+With APIKit used along with APIKitExt, we can parse Json result and immediately return Response type :tada:
+```swift
+struct RepoRequest: Request {
+    typealias Response = [Repo]
+    // ...
+}
+
+extension RepoRequest {
+    func response(from object: Any, urlResponse: HTTPURLResponse) -> [Repo] {
+        guard
+            let tree = object as? [String: Any],
+            let items = tree["items"],
+            let repos = try? Repo.mapArray(items) // <- notice mapArray method here !
+        else {
+            return []
+        }
+        return repos
+    }
+}
+```
+
+### Supported method
+Here is list of supported methods
+* `mapObject` : map a json object to a model object.
+* `mapArray` : map a json object to a list of model objects.

HimotokiUsage.md

@@ -1 +1,53 @@
 ## How to use APIKit + Himotoki
+Example using APIKitExt to combine APIKit and Himotoki.
+Note that a complete example is available at [Himotoki Sample folder](https://github.com/DTVD/APIKitExt/tree/master/Example/Himotoki%20Sample).
+
+### Model (Himotoki)
+Our model file will follow normal Himotoki's guide.
+```swift
+struct Repo {
+    var id: Int
+    var fullName: String
+    var avatar: String
+    var stargazersCount: Int
+}
+
+extension Repo: Decodable {
+    static func decode(_ e: Extractor) throws -> Repo {
+        return try Repo(
+            id: e <| "id",
+            fullName: e <| "full_name",
+            avatar: e <| ["owner", "avatar_url"],
+            stargazersCount: e <| "stargazers_count"
+        )
+    }
+}
+
+```
+
+### Defining request type (APIKit + APIKitExt)
+With APIKit used along with APIKitExt, we can parse Json result and immediately return Response type :tada:
+```swift
+struct RepoRequest: Request {
+    typealias Response = [Repo]
+    // ...
+}
+
+extension RepoRequest {
+    func response(from object: Any, urlResponse: HTTPURLResponse) -> [Repo] {
+        guard
+            let tree = object as? [String: Any],
+            let items = tree["items"],
+            let repos = try? Repo.mapArray(items) // <- notice mapArray method here !
+        else {
+            return []
+        }
+        return repos
+    }
+}
+```
+
+### Supported method
+Here is list of supported methods
+* `mapObject` : map a json object to a model object.
+* `mapArray` : map a json object to a list of model objects.

ObjectMapperUsage.md

@@ -1 +1,48 @@
 ## How to use APIKit + ObjectMapper
+Example using APIKitExt to combine APIKit and ObjectMapper.
+Note that a complete example is available at [Object Mapper Sample folder](https://github.com/DTVD/APIKitExt/tree/master/Example/ObjectMapper%20Sample).
+
+### Model (ObjectMapper)
+Our model file will follow normal ObjectMapper's guide.
+```swift
+struct Repo: Mappable {
+    var id: Int!
+    var fullName: String!
+    var stargazersCount: Int!
+
+    init?(map: Map) {}
+
+    mutating func mapping(map: Map) {
+        id              <- map["id"]
+        fullName        <- map["full_name"]
+        stargazersCount <- map["stargazers_count"]
+    }
+}
+```
+
+### Defining request type (APIKit + APIKitExt)
+With APIKit used along with APIKitExt, we can parse Json result and immediately return Response type :tada:
+```swift
+struct RepoRequest: Request {
+    typealias Response = [Repo]
+    // ...
+}
+
+extension RepoRequest {
+    func response(from object: Any, urlResponse: HTTPURLResponse) -> [Repo] {
+        guard
+            let tree = object as? [String: Any],
+            let items = tree["items"],
+            let repos = try? Repo.mapArray(items) // <- notice mapArray method here !
+            else {
+                return []
+        }
+        return repos
+    }
+}
+```
+
+### Supported method
+Here is list of supported methods
+* `mapObject` : map a json object to a model object.
+* `mapArray` : map a json object to a list of model objects.

README.md

@@ -1,6 +1,7 @@
 # APIKitExt
 [![Build Status](https://travis-ci.org/DTVD/APIKitExt.svg?branch=master)](https://travis-ci.org/DTVD/APIKitExt)
 [![Version](https://img.shields.io/cocoapods/v/APIKitExt.svg)]()
+[![Language](https://img.shields.io/badge/language-swift3.0-f48041.svg?style=flat)](https://developer.apple.com/swift)
 
 Extensions for famous type-safe networking library [APIKit](https://github.com/ishkawa/APIKit), provides easy binding with various JSON serialization libraries such as [ObjectMapper](https://github.com/Hearst-DD/ObjectMapper), [Argo](https://github.com/thoughtbot/Argo), [Himotoki](https://github.com/ikesyo/Himotoki) and also Reactive Extension for [RxSwift](https://github.com/ReactiveX/RxSwift) :tada:
 
@@ -12,11 +13,19 @@ Extensions for famous type-safe networking library [APIKit](https://github.com/i
 * tvOS 9.0 or later
 
 ## Installation
-APIKitExt is available through [CocoaPods](http://cocoapods.org). To install
-it, simply add the following line to your Podfile:
+APIKitExt is available through [CocoaPods](http://cocoapods.org). Depend on which Json serialization library that you want to use with APIKit, you can add to your Podfile as below:
 
 ```ruby
-pod "APIKitExt"
+# APIKit + ObjectMapper
+pod "APIKitExt/ObjectMapper"
+```
+```ruby
+# APIKit + Argo
+pod "APIKitExt/Argo"
+```
+```ruby
+# APIKit + Himotoki
+pod "APIKitExt/Himotoki"
 ```
 
 # Usage