Skip to content

Commit

Permalink
Documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
tcldr committed Jun 24, 2019
1 parent 8fee6d6 commit 5c26eac
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
4 changes: 2 additions & 2 deletions Assets/Entwine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ import PackageDescription
let package = Package(
...
dependencies: [
.package(url: "http://github.com/tcldr/Entwine.git", .upToNextMajor(from: "0.1.0")),
.package(url: "http://github.com/tcldr/Entwine.git", .upToNextMinor(from: "0.1.0")),
],
...
targets: [.target(name: "MyTarget", dependencies: ["Entwine"]),
Expand All @@ -85,7 +85,7 @@ let package = Package(
### As part of an Xcode 11 or greater project:
1. Select the `File -> Swift Packages -> Add package dependency...` menu item.
2. Enter the repository url `https://github.com/tcldr/Entwine` and tap next.
3. Select 'version, 'up to next major', enter `0.1.0`, hit next.
3. Select 'version, 'up to next minor', enter `0.1.0`, hit next.
4. Select the _Entwine_ library and specify the target you wish to use it with.


Expand Down
4 changes: 2 additions & 2 deletions Assets/EntwineTest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ import PackageDescription
let package = Package(
...
dependencies: [
.package(url: "http://github.com/tcldr/EntwineTest.git", .upToNextMajor(from: "0.1.0")),
.package(url: "http://github.com/tcldr/EntwineTest.git", .upToNextMinor(from: "0.1.0")),
],
...
targets: [.testTarget(name: "MyTestTarget", dependencies: ["EntwineTest"]),
Expand All @@ -218,7 +218,7 @@ let package = Package(
### As part of an Xcode 11 or greater project:
1. Select the `File -> Swift Packages -> Add package dependency...` menu item.
2. Enter the repository url `https://github.com/tcldr/Entwine` and tap next.
3. Select 'version, 'up to next major', enter `0.1.0`, hit next.
3. Select 'version, 'up to next minor', enter `0.1.0`, hit next.
4. Select the _EntwineTest_ library and specify the test target you wish to use it with.


Expand Down
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,22 @@ Accessories for [Apple's Combine Framework](https://developer.apple.com/document
Entwine consists of three libraries (over two repositories) to be used in conjuction with Apple's Combine framework:
- The [_Entwine Utilities library_](https://github.com/tcldr/Entwine/blob/master/Assets/Entwine/README.md) includes additional operators, subjects and utilities for working with Combine sequences.
The package currently includes a `ReplaySubject`, a `withLatest(from:)` operator and a `Publishers.Factory` for rapidly defining publishers inline from any source.

**[View the README for the Entwine Utilities Library](https://github.com/tcldr/Entwine/blob/master/Assets/Entwine/README.md)**

- The [_EntwineTest library_](https://github.com/tcldr/Entwine/blob/master/Assets/EntwineTest/README.md) consists of tools for verifying expected behavior of Combine sequences. It houses
a `TestScheduler` that uses virtual time, a `TestablePublisher` that schedules a user-defined sequence of
elements in absolute or relative time, and a `TestableSubscriber` that record a time-stamped list of events that can
be compared against expected behavior.
elements in absolute or relative time, and a `TestableSubscriber` that record a time-stamped list of events that can be compared against expected behavior.

**[View the README for the EntwineTest Library](https://github.com/tcldr/Entwine/blob/master/Assets/EntwineTest/README.md)**

- The [_EntwineRx library_](https://github.com/tcldr/EntwineRx/blob/master/README.md) is a small library maintained under a [separate repository](https://github.com/tcldr/EntwineRx) that contains bridging operators from RxSwift to Combine and vice versa
making _RxSwift_ and _Combine_ work together seamlessly.

**[View the README for the EntwineRx Library](https://github.com/tcldr/EntwineRx)**



_Note: EntwineRx is maintained as a separate Swift package to minimize the SPM dependency graph_.


Expand Down

0 comments on commit 5c26eac

Please sign in to comment.