Skip to content

Commit 9acbb2a

Browse files
dtvdorakaro
authored andcommitted
Update README.md
1 parent e1939d3 commit 9acbb2a

File tree

4 files changed

+25
-11
lines changed

4 files changed

+25
-11
lines changed

ArgoUsage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
## How to use APIKit + Argo

HimotokiUsage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
## How to use APIKit + Himotoki

ObjectMapperUsage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
## How to use APIKit + ObjectMapper

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,38 @@
11
# APIKitExt
2+
[![Build Status](https://travis-ci.org/DTVD/APIKitExt.svg?branch=master)](https://travis-ci.org/DTVD/APIKitExt)
23

3-
[![CI Status](http://img.shields.io/travis/Orakaro/APIKitExt.svg?style=flat)](https://travis-ci.org/DTVD/APIKitExt)
4-
[![Version](https://img.shields.io/cocoapods/v/APIKitExt.svg?style=flat)](http://cocoapods.org/pods/APIKitExt)
4+
Extensions for famous type-safe networking library [APIKit](https://github.com/ishkawa/APIKit), provides easy binding with various JSON serialization 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:
55

6-
## Example
7-
8-
To run the example project, clone the repo, and run `pod install` from the Example directory first.
9-
10-
## Requirements
6+
## Requirement
7+
* Swift 3.0
8+
* iOS 8.0 or later
9+
* Mac OS 10.10 or later
10+
* watchOS 2.0 or later
11+
* tvOS 9.0 or later
1112

1213
## Installation
13-
1414
APIKitExt is available through [CocoaPods](http://cocoapods.org). To install
1515
it, simply add the following line to your Podfile:
1616

1717
```ruby
1818
pod "APIKitExt"
1919
```
2020

21-
## Author
21+
# Usage
22+
Below are detailed explanations for each combination of APIKit and JSON serialization library. You can also check demo apps in Example folder.
2223

23-
24+
* [x] [APIKit + ObjectMapper](https://github.com/DTVD/APIKitExt/blob/master/ObjectMapperUsage.md)
25+
* [x] [APIKit + Argo](https://github.com/DTVD/APIKitExt/blob/master/ArgoUsage.md)
26+
* [x] [APIKit + Himotoki](https://github.com/DTVD/APIKitExt/blob/master/HimotokiUsage.md)
27+
* [ ] APIKit + SwiftyJSON
28+
* [ ] APIKit + ModelMapper
29+
* [ ] APIKit + JASON
30+
* [ ] APIKit + Unbox
2431

25-
## License
32+
The demo app for APIKit + APIKitExt + Himotoki + RxSwift is following MVVM architecture with reactive unit test included. Check it out and have fun!
2633

34+
<img src="http://i.imgur.com/QHqZqOA.png" width="400"/>
35+
36+
37+
## License
2738
APIKitExt is available under the MIT license. See the LICENSE file for more info.

0 commit comments

Comments
 (0)