ReactiveX/RxSwift
1
1
Fork 0
mirror of https://github.com/ReactiveX/RxSwift.git synced 2024-10-04 22:17:41 +03:00
Code Issues Projects Releases Wiki Activity

Updates README.md

Browse Source
This commit is contained in:
Krunoslav Zaher 2017-10-18 00:55:45 +02:00
parent 12cccb171a
commit d52c3a8628
No known key found for this signature in database
GPG Key ID: 74BC718B68EA3842
1 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -3,8 +3,7 @@
[![Travis CI](https://travis-ci.org/ReactiveX/RxSwift.svg?branch=master)](https://travis-ci.org/ReactiveX/RxSwift) ![platforms](https://img.shields.io/badge/platforms-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20watchOS%20%7C%20Linux-333333.svg) ![pod](https://img.shields.io/cocoapods/v/RxSwift.svg) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)
* RxSwift 4.x / Swift 4.x can be found in [**rxswift4.0-swift4.0** branch](https://github.com/ReactiveX/RxSwift/tree/rxswift4.0-swift4.0).
* RxSwift 3.x / Swift 3.x can be found in [**master** branch](https://github.com/ReactiveX/RxSwift/tree/master).
* RxSwift 3.x / Swift 3.x can be found in [**rxswift-3.0** branch](https://github.com/ReactiveX/RxSwift/tree/rxswift-3.0).
Rx is a [generic abstraction of computation](https://youtu.be/looJcaeboBY) expressed through `Observable<Element>` interface.
@ -105,8 +104,9 @@ searchResults
## Requirements
* Xcode 8.0
* Swift 3.0
* Xcode 9.0
* Swift 4.0
* Swift 3.x ([use `rxswift-3.0` branch](https://github.com/ReactiveX/RxSwift/tree/rxswift-3.0) instead)
* Swift 2.3 ([use `rxswift-2.0` branch](https://github.com/ReactiveX/RxSwift/tree/rxswift-2.0) instead)
## Installation
@ -121,21 +121,21 @@ Open Rx.xcworkspace, choose `RxExample` and hit run. This method will build ever
### [CocoaPods](https://guides.cocoapods.org/using/using-cocoapods.html)
**Tested with `pod --version`: `1.1.1`**
**Tested with `pod --version`: `1.3.1`**
```ruby
# Podfile
use_frameworks!
target 'YOUR_TARGET_NAME' do
pod 'RxSwift', '~> 3.0'
pod 'RxCocoa', '~> 3.0'
pod 'RxSwift', '~> 4.0'
pod 'RxCocoa', '~> 4.0'
end
# RxTests and RxBlocking make the most sense in the context of unit/integration tests
target 'YOUR_TESTING_TARGET' do
pod 'RxBlocking', '~> 3.0'
pod 'RxTest', '~> 3.0'
pod 'RxBlocking', '~> 4.0'
pod 'RxTest', '~> 4.0'
end
```
@ -147,12 +147,12 @@ $ pod install
### [Carthage](https://github.com/Carthage/Carthage)
**Tested with `carthage version`: `0.18.1`**
**Tested with `carthage version`: `0.26.2`**
Add this to `Cartfile`
```
github "ReactiveX/RxSwift" ~> 3.0
github "ReactiveX/RxSwift" ~> 4.0
```
```bash
@ -161,19 +161,23 @@ $ carthage update
### [Swift Package Manager](https://github.com/apple/swift-package-manager)
**Tested with `swift build --version`: `3.0.0 (swiftpm-19)`**
**Tested with `swift build --version`: `Swift 4.0.0-dev (swiftpm-13126)`**
Create a `Package.swift` file.
```swift
// swift-tools-version:4.0
import PackageDescription
let package = Package(
name: "RxTestProject",
targets: [],
dependencies: [
.Package(url: "https://github.com/ReactiveX/RxSwift.git", majorVersion: 3)
]
name: "RxTestProject",
dependencies: [
.package(url: "https://github.com/ReactiveX/RxSwift.git", "4.0.0" ..< "5.0.0")
],
targets: [
.target(name: "RxTestProject", dependencies: ["RxSwift", "RxCocoa"])
]
)
```