Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with badges and package manager info. #96

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README with badges and package manager info. #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ _NOTE: This is legacy introduction to the Objective-C ReactiveCocoa, which is
now known as ReactiveObjC. For the updated version that uses Swift, please see
[ReactiveCocoa][] or [ReactiveSwift][]_

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](#carthage) [![CocoaPods compatible](https://img.shields.io/cocoapods/v/ReactiveObjC.svg)](#cocoapods) [![GitHub release](https://img.shields.io/github/release/ReactiveCocoa/ReactiveObjC.svg)](https://github.com/ReactiveCocoa/ReactiveObjC/releases) ![platforms](https://img.shields.io/badge/platform-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20watchOS-lightgrey.svg)

ReactiveObjC (formally ReactiveCocoa or RAC) is an Objective-C framework
inspired by [Functional Reactive Programming][]. It provides APIs for
**composing and transforming streams of values**.
Expand Down Expand Up @@ -484,9 +486,9 @@ RACSequence *results = [[strings.rac_sequence
}];
```

## System Requirements
## Getting started

ReactiveObjC supports OS X 10.8+ and iOS 8.0+.
ReactiveObjC supports macOS 10.9+, iOS 8.0+, watchOS 2.0+ and tvOS 9.0+.

## Importing ReactiveObjC

Expand All @@ -513,6 +515,26 @@ To add RAC to your application:
To see a project already set up with RAC, check out [C-41][] or [GroceryList][],
which are real iOS apps written using ReactiveObjC.

#### Carthage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this go above the submodule section (the same way it is in ReactiveCocoa)? It seems like Carthage or CocoaPods would be the most common installation routes over submodules.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should have a #### Git Submodules header too, I think.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the section need to be updated though? It seems too complicated if linking the library is enough (in regard to Carthage and Pods).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think moving it to the bottom of the list and adding a header is sufficient.


If you use [Carthage][] to manage your dependencies, simply add
ReactiveObjC to your `Cartfile`:

```
github "ReactiveCocoa/ReactiveObjC" ~> 3.0
```

If you use Carthage to build your dependencies, make sure you have added `ReactiveObjC.framework` to the "_Linked Frameworks and Libraries_" section of your target, and have included them in your Carthage framework copying build phase.

#### CocoaPods

If you use [CocoaPods][] to manage your dependencies, simply add
ReactiveObjC to your `Podfile`:

```
pod 'ReactiveObjC', '~> 3.0'
```

## More Info

ReactiveObjC is inspired by .NET's [Reactive
Expand Down Expand Up @@ -545,3 +567,5 @@ are some resources related to FRP:
[RACSignal]: ReactiveOjC/RACSignal.h
[futures and promises]: http://en.wikipedia.org/wiki/Futures_and_promises
[C-41]: https://github.com/AshFurrow/C-41
[Carthage]: https://github.com/Carthage/Carthage/
[CocoaPods]: https://cocoapods.org/