mirror of
https://github.com/apple/swift-nio-extras.git
synced 2025-05-14 17:02:43 +08:00
update README: upToNextMinor & current contents
Motivation: It's better for users to depend on `.upToNextMinor` instead of `.exact` versions and I previously forgot to mention the quiescing helper in the readme. Modifications: - mention quiescing helper in readme - recommend to depend on this package with `.upToNextMinor` Result: better readme
This commit is contained in:
parent
2516d61aee
commit
fa86c32432
@ -16,14 +16,17 @@ followed as in the other SwiftNIO repositories. We indicate this by starting
|
||||
with major version 0 (`0.x.y`). We will try to increment the minor version
|
||||
number whenever there is a breaking change until we release `1.0.0` when we will
|
||||
start to follow the usual SemVer requirements. We recommend that users depend on
|
||||
the exact version.
|
||||
`.upToNextMinor` as we reserve the right to introduce breaking changes with
|
||||
minor version increments. For patch level increments, we might only introduce new
|
||||
functionality.
|
||||
|
||||
## Using NIOExtras:
|
||||
|
||||
dependencies: [
|
||||
.package(url: "https://github.com/apple/swift-nio-extras.git", .exact("0.0.1")),
|
||||
.package(url: "https://github.com/apple/swift-nio-extras.git", .upToNextMinor("0.1.0")),
|
||||
],
|
||||
|
||||
## Current Contents
|
||||
|
||||
_empty_
|
||||
- [`QuiescingHelper`](Sources/NIOExtras/QuiescingHelper.swift): Helps to quiesce
|
||||
a server by notifying user code when all previously open connections have closed.
|
||||
|
Loading…
x
Reference in New Issue
Block a user