Skip to content

Commit 0602dd3

Browse files
committed
README.md updates
1 parent 99865ef commit 0602dd3

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

Assets/Entwine/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,11 @@ import PackageDescription
7272
let package = Package(
7373
...
7474
dependencies: [
75-
.package(url: "http://github.com/tcldr/Entwine.git", .upToNextMinor(from: "0.1.0")),
75+
.package(url: "http://github.com/tcldr/Entwine.git", .upToNextMajor(from: "0.0.0")),
7676
],
7777
...
78-
targets: [.target(name: "MyTarget", dependencies: ["Entwine"]),
78+
targets: [
79+
.target(name: "MyTarget", dependencies: ["Entwine"]),
7980
]
8081
)
8182
```
@@ -85,9 +86,10 @@ let package = Package(
8586
### As part of an Xcode 11 or greater project:
8687
1. Select the `File -> Swift Packages -> Add package dependency...` menu item.
8788
2. Enter the repository url `https://github.com/tcldr/Entwine` and tap next.
88-
3. Select 'version, 'up to next minor', enter `0.1.0`, hit next.
89+
3. Select 'version, 'up to next major', enter `0.0.0`, hit next.
8990
4. Select the _Entwine_ library and specify the target you wish to use it with.
9091

92+
*n.b. _Entwine_ is pre-release software and as such the API may change prior to reaching 1.0. For finer-grained control please use `.upToNextMinor(from:)` in your SPM dependency declaration*
9193

9294
---
9395

@@ -101,4 +103,4 @@ Copyright 2019 © Tristan Celder
101103

102104
_Entwine_ is made available under the [MIT License](http://github.com/tcldr/Entwine/blob/master/LICENSE)
103105

104-
---
106+
---

Assets/EntwineTest/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -148,15 +148,15 @@ print("sequences match: \(expected == subscriber.sequence)")
148148
## Putting it all together
149149
Now that we have our `TestScheduler`, `TestPublisher`, and `TestSubscriber` let's put them together to test our operators and sequences.
150150

151-
But first, there's one additional method that you should be aware of. That's the `start(_:)` method on `TestScheduler`.
151+
But first, there's one additional method that you should be aware of. That's the `start(create:)` method on `TestScheduler`.
152152

153-
The `start(_:)` method accepts a closure that produces any publisher and then:
153+
The `start(create:)` method accepts a closure that produces any publisher and then:
154154
1. Schedules the creation of the publisher (invocation of the passed closure) at `100`
155155
2. Schedules the subscription of the publisher to a `TestableSubscriber` at `200`
156156
3. Schedules the cancellation of the subscription at `900`
157157
4. Resumes the scheduler clock
158158

159-
_These are all configurable by using the `start(configuration:_:)` method. See the docs for more info._
159+
_These are all configurable by using the `start(configuration:create:)` method. See the docs for more info._
160160

161161
With that knowledge in place, let's test _Combine_'s map operator. (I'm sure it's fine – but just in case.)
162162

@@ -197,18 +197,19 @@ Hopefully this should be everything you need to get you started with testing you
197197

198198
### INSTALLATION
199199
### As part of another Swift Package:
200-
1. Include it in your `Package.swift` file as both a dependency and a dependency of your test target.
200+
1. Include it in your `Package.swift` file as both a dependency and a dependency of your target.
201201

202202
```swift
203203
import PackageDescription
204204

205205
let package = Package(
206206
...
207207
dependencies: [
208-
.package(url: "http://github.com/tcldr/EntwineTest.git", .upToNextMinor(from: "0.1.0")),
208+
.package(url: "http://github.com/tcldr/Entwine.git", .upToNextMajor(from: "0.0.0")),
209209
],
210210
...
211-
targets: [.testTarget(name: "MyTestTarget", dependencies: ["EntwineTest"]),
211+
targets: [
212+
.testTarget(name: "MyTestTarget", dependencies: ["EntwineTest"]),
212213
]
213214
)
214215
```
@@ -218,9 +219,10 @@ let package = Package(
218219
### As part of an Xcode 11 or greater project:
219220
1. Select the `File -> Swift Packages -> Add package dependency...` menu item.
220221
2. Enter the repository url `https://github.com/tcldr/Entwine` and tap next.
221-
3. Select 'version, 'up to next minor', enter `0.1.0`, hit next.
222-
4. Select the _EntwineTest_ library and specify the test target you wish to use it with.
222+
3. Select 'version, 'up to next major', enter `0.0.0`, hit next.
223+
4. Select the _EntwineTest_ library and specify the target you wish to use it with.
223224

225+
*n.b. _EntwineTest_ is pre-release software and as such the API may change prior to reaching 1.0. For finer-grained control please use `.upToNextMinor(from:)` in your SPM dependency declaration*
224226

225227
---
226228

0 commit comments

Comments
 (0)