Skip to content

Commit 4772e16

Browse files
authored
Restructure readme to incorporate a list of "extended modules". [skip ci] (#789)
1 parent 3f4351d commit 4772e16

File tree

1 file changed

+37
-39
lines changed

1 file changed

+37
-39
lines changed

README.md

Lines changed: 37 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,41 @@
77

88
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](#carthage) [![CocoaPods compatible](https://img.shields.io/cocoapods/v/ReactiveSwift.svg)](#cocoapods) [![SwiftPM compatible](https://img.shields.io/badge/SwiftPM-compatible-orange.svg)](#swift-package-manager) [![GitHub release](https://img.shields.io/github/release/ReactiveCocoa/ReactiveSwift.svg)](https://github.com/ReactiveCocoa/ReactiveSwift/releases) ![Swift 5.1](https://img.shields.io/badge/Swift-5.1-orange.svg) ![platforms](https://img.shields.io/badge/platform-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20watchOS%20%7C%20Linux-lightgrey.svg)
99

10-
🎉 [Getting Started](#getting-started) 🚄 [Release Roadmap](#release-roadmap)
10+
🚄 [Release Roadmap](#release-roadmap)
1111

12-
## What is ReactiveSwift?
12+
## Getting Started
13+
14+
Learn about the **[Core Reactive Primitives][]** in ReactiveSwift, and **[Basic Operators][]** available offered by these primitives.
15+
16+
### Extended modules
17+
18+
<table>
19+
<tr>
20+
<th>Module</th>
21+
<th>Repository</th>
22+
<th>Description</th>
23+
</tr>
24+
<tr>
25+
<td>ReactiveCocoa</td>
26+
<td>
27+
<a href="https://github.com/ReactiveCocoa/ReactiveCocoa">ReactiveCocoa/ReactiveCocoa</a>
28+
<br />
29+
<a href="https://github.com/ReactiveCocoa/ReactiveCocoa/releases"><img src="https://img.shields.io/github/release/ReactiveCocoa/ReactiveCocoa.svg" /><a>
30+
</td>
31+
<td><p>Extend Cocoa frameworks and Objective-C runtime APIs with ReactiveSwift bindings and extensions.</p></td>
32+
</tr>
33+
<tr>
34+
<td>Loop</td>
35+
<td>
36+
<a href="https://github.com/ReactiveCocoa/Loop">ReactiveCocoa/Loop</a>
37+
<br />
38+
<a href="https://github.com/ReactiveCocoa/Loop/releases"><img src="https://img.shields.io/github/release/ReactiveCocoa/Loop.svg" /><a>
39+
</td>
40+
<td><p>Composable unidirectional data flow with ReactiveSwift.</p></td>
41+
</tr>
42+
</table>
43+
44+
## What is ReactiveSwift in a nutshell?
1345
__ReactiveSwift__ offers composable, declarative and flexible primitives that are built around the grand concept of ___streams of values over time___.
1446

1547
These primitives can be used to uniformly represent common Cocoa and generic programming patterns that are fundamentally an act of observation, e.g. delegate pattern, callback closures, notifications, control actions, responder chain events, [futures/promises](https://en.wikipedia.org/wiki/Futures_and_promises) and [key-value observing](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/KeyValueObserving/KeyValueObserving.html) (KVO).
@@ -18,41 +50,7 @@ Because all of these different mechanisms can be represented in the _same_ way,
1850
it’s easy to declaratively compose them together, with less spaghetti
1951
code and state to bridge the gap.
2052

21-
## Getting Started
22-
23-
1. **[Core Reactive Primitives][]**
24-
25-
An overview of the semantics and example use cases of the ReactiveSwift primitives, including [`Signal`][], [`SignalProducer`][], [`Property`][] and [`Action`][].
26-
27-
1. **[Basic Operators][]**
28-
29-
An overview of the operators provided to compose and transform streams of values.
30-
31-
1. **[ReactiveCocoa][ReactiveCocoa]**
32-
33-
Building on top of ReactiveSwift, **ReactiveCocoa** extends Cocoa platform frameworks with reactive bindings and extensions.
34-
35-
[![GitHub release](https://img.shields.io/github/release/ReactiveCocoa/ReactiveCocoa.svg)](https://github.com/ReactiveCocoa/ReactiveCocoa/releases)[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/ReactiveCocoa/ReactiveCocoa/#carthage) [![CocoaPods compatible](https://img.shields.io/cocoapods/v/ReactiveCocoa.svg)](https://github.com/ReactiveCocoa/ReactiveCocoa/#cocoapods)
36-
37-
1. **[How does ReactiveSwift relate to RxSwift?][]**
38-
39-
An overview of how ReactiveSwift differs from RxSwift for Swift idiomaticity.
40-
41-
## Examples
42-
43-
1. **Interactive Form UI**
44-
45-
ReactiveSwift includes a [_UI Examples_ playground][], which demonstrates:
46-
* how to build an interactive form UI with bindings, properties and `Action`s, with a live view in action.
47-
* how to use reactive primitives to implement the Model-View-ViewModel architectural pattern, with the View Model being the source of truth for the View.
48-
49-
1. **[Online Searching][]**
50-
51-
## Advanced Topics
52-
53-
1. **[ReactiveCocoa][]**
54-
55-
Bindings and reactive extensions for Cocoa and Cocoa Touch frameworks are offered separately as ReactiveCocoa.
53+
## References
5654

5755
1. **[API Reference][]**
5856

@@ -109,7 +107,7 @@ of your package in `Package.swift`:
109107

110108
## Playground
111109

112-
We also provide a great Playground, so you can get used to ReactiveCocoa's operators. In order to start using it:
110+
We also provide a Playground, so you can get used to ReactiveCocoa's operators. In order to start using it:
113111

114112
1. Clone the ReactiveSwift repository.
115113
1. Retrieve the project dependencies using one of the following terminal commands from the ReactiveSwift project root directory:
@@ -128,7 +126,7 @@ If you need any help, please visit our [GitHub issues][] or [Stack Overflow][].
128126

129127
### Plan of Record
130128
#### ABI stability release
131-
ReactiveSwift is expected to declare library ABI stability when Swift rolls out resilence support. Until then, ReactiveSwift would incrementally adopt new language features that help move towards to goal.
129+
ReactiveSwift has no plan to declare ABI and module stability at the moment. It will continue to be offered as a source only dependency for the foreseeable future.
132130

133131
[Core Reactive Primitives]: Documentation/ReactivePrimitives.md
134132
[Basic Operators]: Documentation/BasicOperators.md

0 commit comments

Comments
 (0)