Skip to content

Commit e1ec2b7

Browse files
authored
Update README.md (#43)
motivation: clearer readme changes: SwiftServiceLifecycle -> Swift Service Lifecycle
1 parent 2891ee7 commit e1ec2b7

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# SwiftServiceLifecycle
1+
# Swift Service Lifecycle
22

3-
SwiftServiceLifecycle provides a basic mechanism to cleanly start up and shut down the application, freeing resources in order before exiting.
3+
Swift Service Lifecycle provides a basic mechanism to cleanly start up and shut down the application, freeing resources in order before exiting.
44
It also provides a `Signal`-based shutdown hook, to shutdown on signals like `TERM` or `INT`.
55

6-
SwiftServiceLifecycle was designed with the idea that every application has some startup and shutdown workflow-like-logic which is often sensitive to failure and hard to get right.
6+
Swift Service Lifecycle was designed with the idea that every application has some startup and shutdown workflow-like-logic which is often sensitive to failure and hard to get right.
77
The library codes this common need in a safe and reusable way that is non-framework specific, and designed to be integrated with any server framework or directly in an application.
88

9-
This is the beginning of a community-driven open-source project actively seeking contributions, be it code, documentation, or ideas. What SwiftServiceLifecycle provides today is covered in the [API docs](https://swift-server.github.io/swift-service-lifecycle/), but it will continue to evolve with community input.
9+
This is the beginning of a community-driven open-source project actively seeking contributions, be it code, documentation, or ideas. What Swift Service Lifecycle provides today is covered in the [API docs](https://swift-server.github.io/swift-service-lifecycle/), but it will continue to evolve with community input.
1010

1111
## Getting started
1212

13-
If you have a server-side Swift application or a cross-platform (e.g. Linux, macOS) application, and you would like to manage its startup and shutdown lifecycle, SwiftServiceLifecycle is a great idea. Below you will find all you need to know to get started.
13+
If you have a server-side Swift application or a cross-platform (e.g. Linux, macOS) application, and you would like to manage its startup and shutdown lifecycle, Swift Service Lifecycle is a great idea. Below you will find all you need to know to get started.
1414

1515
### Adding the dependency
1616

@@ -20,7 +20,7 @@ To add a dependency on the package, declare it in your `Package.swift`:
2020
.package(url: "https://github.com/swift-server/swift-service-lifecycle.git", from: "1.0.0-alpha.3"),
2121
```
2222

23-
and to your application target, add "SwiftServiceLifecycle" to your dependencies:
23+
and to your application target, add `Lifecycle` to your dependencies:
2424

2525
```swift
2626
.target(name: "MyApplication", dependencies: ["Lifecycle"]),
@@ -247,7 +247,7 @@ lifecycle.wait()
247247

248248
[SwiftNIO](https://github.com/apple/swift-nio) is a popular networking library that among other things provides Future abstraction named `EventLoopFuture`.
249249

250-
SwiftServiceLifecycle comes with a compatibility module designed to make managing SwiftNIO based resources easy.
250+
Swift Service Lifecycle comes with a compatibility module designed to make managing SwiftNIO based resources easy.
251251

252252
Once you import `LifecycleNIOCompat` module, `LifecycleHandler` gains a static helper named `eventLoopFuture` designed to help simplify the registration call to:
253253

0 commit comments

Comments
 (0)