Skip to content

Commit b5d25d5

Browse files
committed
refactor: rename package to follow existing patterns in Apple's Swift repositories, to make this as easy as possible for them to adopt.
1 parent 3c3df38 commit b5d25d5

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
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: "dispatch-async",
6+
name: "swift-dispatch-async",
77
products: [
88
.library(
99
name: "DispatchAsync",

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# dispatch-async
1+
# swift-dispatch-async
22

33
## ⚠️ WARNING - This is an 🧪experimental🧪 repository and should not be adopted at large.
44

@@ -87,7 +87,7 @@ let package = Package(
8787
],
8888
dependencies: [
8989
.package(
90-
url: "https://github.com/PassiveLogic/dispatch-async.git",
90+
url: "https://github.com/PassiveLogic/swift-dispatch-async.git",
9191
from: "0.0.1"
9292
),
9393
],
@@ -113,10 +113,10 @@ import DispatchAsync
113113
@_spi(DispatchAsync) import DispatchAsync
114114
#endif
115115

116-
// Not allowed:
116+
// Not allowed, brings in Dispatch, aka "the real GCD":
117117
// import Dispatch
118118

119-
// Also Not allowed:
119+
// Also not allowed, brings in Dispatch
120120
// import Foundation
121121

122122
// You'll need to use scoped Foundation imports:
@@ -125,7 +125,7 @@ import struct Foundation.URL // Ok. Doesn't bring in Dispatch
125125
// If you ignore the above notes, but do the following, be prepared for namespace
126126
// collisions between the toolchain's Dispatch and DispatchAsync:
127127

128-
private typealias DispatchQueue = DispatchAsync.DispatchQueue
128+
private typealias DispatchQueue = DispatchAsync.DispatchQueue // Ok as long as Dispatch isn't imported
129129

130130
// Ok. If you followed everything above, you can now do the following, using pure Swift
131131
// under the hood! 🎉
@@ -137,5 +137,5 @@ DispatchQueue.main.async {
137137
# LICENSE
138138

139139
This project is distributed by PassiveLogic under the Apache-2.0 license. See
140-
[LICENSE](https://github.com/PassiveLogic/dispatch-async/blob/main/LICENSE) for full terms of use.
140+
[LICENSE](https://github.com/PassiveLogic/swift-dispatch-async/blob/main/LICENSE) for full terms of use.
141141

0 commit comments

Comments
 (0)