Skip to content

Commit b7071a5

Browse files
committed
README
1 parent 9fce6f3 commit b7071a5

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
11
# RxIGListKit
22

3+
A RxSwift wrapper for Instagram's [IGListKit](https://github.com/Instagram/IGListKit) - A data-driven `UICollectionView` framework for building fast and flexible lists.RxIGListKit bring IGListKit into Reactive world.
4+
35
[![CI Status](https://img.shields.io/travis/Bruce-pac/RxIGListKit.svg?style=flat)](https://travis-ci.org/Bruce-pac/RxIGListKit)
46
[![Version](https://img.shields.io/cocoapods/v/RxIGListKit.svg?style=flat)](https://cocoapods.org/pods/RxIGListKit)
7+
![Carthage](https://camo.githubusercontent.com/3dc8a44a2c3f7ccd5418008d1295aae48466c141/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f43617274686167652d636f6d70617469626c652d3442433531442e7376673f7374796c653d666c6174)
58
[![License](https://img.shields.io/cocoapods/l/RxIGListKit.svg?style=flat)](https://cocoapods.org/pods/RxIGListKit)
69
[![Platform](https://img.shields.io/cocoapods/p/RxIGListKit.svg?style=flat)](https://cocoapods.org/pods/RxIGListKit)
710

811
## Example
912

1013
To run the example project, clone the repo, and run `pod install` from the Example directory first.
1114

15+
```swift
16+
let dataSource = RxListAdapterDataSource<String>(sectionControllerProvider: { _,_ in
17+
LabelSectionController()
18+
})
19+
let objectsSignal = BehaviorSubject<[String]>(value: [])
20+
objectsSignal.bind(to: adapter.rx.objects(dataSource: dataSource)).disposed(by: bag)
21+
```
22+
1223
## Requirements
1324

25+
Swift 5 & Xcode 10.2 & RxCocoa
26+
1427
## Installation
1528

1629
RxIGListKit is available through [CocoaPods](https://cocoapods.org). To install
@@ -20,9 +33,15 @@ it, simply add the following line to your Podfile:
2033
pod 'RxIGListKit'
2134
```
2235

36+
For [Carthage](https://github.com/Carthage/Carthage), add the following to your `Cartfile`:
37+
38+
```
39+
github "RxIGListKit"
40+
```
41+
2342
## Author
2443

25-
Bruce-pac, guxinye@dinghaotech.com
44+
Bruce-pac, Bruce_pac312@foxmail.com
2645

2746
## License
2847

0 commit comments

Comments
 (0)