Skip to content

Commit d18349b

Browse files
authored
update package name to swift-service-lifecycle (#39)
* update package name to swift-service-lifecycle motivation: better name changes: update package name and readme
1 parent 49d9472 commit d18349b

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed

Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import PackageDescription
44

55
let package = Package(
6-
name: "swift-service-bootstrap",
6+
name: "swift-service-lifecycle",
77
platforms: [
88
.macOS(.v10_12),
99
],

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
# SwiftServiceBootstrap
1+
# SwiftServiceLifecycle
22

3-
SwiftServiceBootstrap provides a basic mechanism to cleanly start up and shut down the application, freeing resources in order before exiting.
3+
SwiftServiceLifecycle 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-
SwiftServiceBootstrap 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+
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.
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 SwiftServiceBootstrap provides today is covered in the [API docs](https://swift-server.github.io/swift-service-bootstrap/), 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 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.
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, SwiftServiceBootstrap 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, SwiftServiceLifecycle is a great idea. Below you will find all you need to know to get started.
1414

1515
### Adding the dependency
1616

1717
To add a dependency on the package, declare it in your `Package.swift`:
1818

1919
```swift
20-
.package(url: "https://github.com/swift-server/swift-service-bootstrap.git", from: "1.0.0-alpha.2"),
20+
.package(url: "https://github.com/swift-server/swift-service-lifecycle.git", from: "1.0.0-alpha.2"),
2121
```
2222

23-
and to your application target, add "SwiftServiceBootstrap" to your dependencies:
23+
and to your application target, add "SwiftServiceLifecycle" 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-
SwiftServiceBootstrap comes with a compatibility module designed to make managing SwiftNIO based resources easy.
250+
SwiftServiceLifecycle comes with a compatibility module designed to make managing SwiftNIO based resources easy.
251251

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

scripts/generate_docs.sh

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@ mkdir -p "$jazzy_dir"
5151
# prep index
5252
module_switcher="$jazzy_dir/README.md"
5353
cat > "$module_switcher" <<"EOF"
54-
# SwiftServiceBootstrap Docs
54+
# SwiftServiceLifecycle Docs
5555
56-
SwiftServiceBootstrap provides a basic mechanism to cleanly start up and shut down the application, freeing resources in order before exiting.
56+
SwiftServiceLifecycle provides a basic mechanism to cleanly start up and shut down the application, freeing resources in order before exiting.
5757
It also provides a Signal based shutdown hook, to shutdown on signals like TERM or INT.
5858
59-
SwiftServiceBootstrap is non-framework specific, designed to be integrated with any server framework or directly in an application.
59+
SwiftServiceLifecycle is non-framework specific, designed to be integrated with any server framework or directly in an application.
6060
61-
To get started with SwiftServiceBootstrap, [`import Lifecycle`](../Lifecycle/index.html).
61+
To get started with SwiftServiceLifecycle, [`import Lifecycle`](../Lifecycle/index.html).
6262
EOF
6363

6464
# run jazzy
@@ -67,18 +67,18 @@ if ! command -v jazzy > /dev/null; then
6767
fi
6868

6969
jazzy_args=(--clean
70-
--author 'SwiftServiceBootstrap team'
70+
--author 'SwiftServiceLifecycle team'
7171
--readme "$module_switcher"
72-
--author_url https://github.com/swift-server/swift-service-bootstrap
73-
--github_url https://github.com/swift-server/swift-service-bootstrap
74-
--github-file-prefix https://github.com/swift-server/swift-service-bootstrap/tree/$version
72+
--author_url https://github.com/swift-server/swift-service-lifecycle
73+
--github_url https://github.com/swift-server/swift-service-lifecycle
74+
--github-file-prefix https://github.com/swift-server/swift-service-lifecycle/tree/$version
7575
--theme fullwidth
7676
--swift-build-tool spm)
7777

7878
for module in "${modules[@]}"; do
7979
args=("${jazzy_args[@]}" --output "$jazzy_dir/docs/$version/$module" --docset-path "$jazzy_dir/docset/$version/$module"
8080
--module "$module" --module-version $version
81-
--root-url "https://swift-server.github.io/swift-service-bootstrap/docs/$version/$module/")
81+
--root-url "https://swift-server.github.io/swift-service-lifecycle/docs/$version/$module/")
8282
if [[ "$(uname -s)" == "Linux" ]]; then
8383
args+=(--sourcekitten-sourcefile "$root_path/.build/sourcekitten/$module.json")
8484
fi

0 commit comments

Comments
 (0)