Skip to content
Permalink
Browse files

Temporary revert README.md until 5.0 is released.

  • Loading branch information...
kzaher committed Apr 8, 2019
1 parent b925744 commit 27b42ed7584a044d9ec6d7968c0d5f464abdcf93
Showing with 21 additions and 12 deletions.
  1. +21 −12 README.md
@@ -3,6 +3,8 @@

[![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)](https://cocoapods.org/pods/RxSwift) [![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 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.

This is a Swift version of [Rx](https://github.com/Reactive-Extensions/Rx.NET).
@@ -102,10 +104,10 @@ searchResults

## Requirements

* Xcode 10.2
* Swift 5.0

For Xcode 10.1 and below, [use RxSwift 4.5](https://github.com/ReactiveX/RxSwift/releases/tag/4.5.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

@@ -119,19 +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.3.1`**

```ruby
# Podfile
use_frameworks!
target 'YOUR_TARGET_NAME' do
pod 'RxSwift', '~> 5'
pod 'RxCocoa', '~> 5'
pod 'RxSwift', '~> 4.0'
pod 'RxCocoa', '~> 4.0'
end
# RxTest and RxBlocking make the most sense in the context of unit/integration tests
target 'YOUR_TESTING_TARGET' do
pod 'RxBlocking', '~> 5'
pod 'RxTest', '~> 5'
pod 'RxBlocking', '~> 4.0'
pod 'RxTest', '~> 4.0'
end
```

@@ -143,10 +147,12 @@ $ pod install

### [Carthage](https://github.com/Carthage/Carthage)

**Tested with `carthage version`: `0.26.2`**

Add this to `Cartfile`

```
github "ReactiveX/RxSwift" ~> 5.0
github "ReactiveX/RxSwift" ~> 4.0
```

```bash
@@ -155,17 +161,19 @@ $ carthage update

### [Swift Package Manager](https://github.com/apple/swift-package-manager)

**Tested with `swift build --version`: `Swift 4.0.0-dev (swiftpm-13126)`**

Create a `Package.swift` file.

```swift
// swift-tools-version:5.0
// swift-tools-version:4.0
import PackageDescription
let package = Package(
name: "RxTestProject",
dependencies: [
.package(url: "https://github.com/ReactiveX/RxSwift.git", from: "5.0.0")
.package(url: "https://github.com/ReactiveX/RxSwift.git", "4.0.0" ..< "5.0.0")

This comment has been minimized.

Copy link
@freak4pc

freak4pc Apr 9, 2019

Collaborator

Why was develop merged into master? Accident?

This comment has been minimized.

Copy link
@kzaher

kzaher Apr 9, 2019

Author Member

No, it was intentional. I usually merge stuff to master from time to time when I'm certain we'll ship something so people can test it before I release it.

I've usually updated the README.md right before the release, but since you've already updated it, haven't considered it.

],
targets: [
.target(name: "RxTestProject", dependencies: ["RxSwift", "RxCocoa"])
@@ -177,7 +185,7 @@ let package = Package(
$ swift build
```

To build or test a module with RxTest dependency, set `TEST=1`.
To build or test a module with RxTest dependency, set `TEST=1`. ([RxSwift >= 3.4.2](https://github.com/ReactiveX/RxSwift/releases/tag/3.4.2))

```bash
$ TEST=1 swift test
@@ -194,6 +202,7 @@ $ git submodule add git@github.com:ReactiveX/RxSwift.git
* Drag `Rx.xcodeproj` into Project Navigator
* Go to `Project > Targets > Build Phases > Link Binary With Libraries`, click `+` and select `RxSwift-[Platform]` and `RxCocoa-[Platform]` targets


## References

* [http://reactivex.io/](http://reactivex.io/)

0 comments on commit 27b42ed

Please sign in to comment.
You can’t perform that action at this time.