Skip to content

Commit 86c59de

Browse files
committed
Prepare README for initial release
1 parent fabcd3d commit 86c59de

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ A Swift Macro for enhanced automatic memberwise initializers, greatly reducing m
99

1010
Informed by explicit developer cues, MemberwiseInit can more often automatically provide your intended memberwise `init`, while following the same safe-by-default semantics underlying [Swift’s memberwise initializers][swifts-memberwise-init].
1111

12-
> :warning: :warning: :warning: **Pre-release**<br>
13-
> I’m on the cusp of the official release and excited to share this with you! Dive in, experiment, and any feedback you provide will be greatly appreciated.
14-
1512
> :warning: **Important**<br>
1613
> `@MemberwiseInit` is a Swift Macro requiring **swift-tools-version: 5.9** or later (**Xcode 15** onwards).
1714
@@ -33,23 +30,24 @@ Informed by explicit developer cues, MemberwiseInit can more often automatically
3330
To use MemberwiseInit:
3431

3532
1. **Installation**
36-
<br> Add MemberwiseInit via Swift Package Manager by providing the package URL to your Xcode project: `https://github.com/gohanlon/swift-memberwise-init-macro`.
33+
<br> In Xcode, add MemberwiseInit with: `File``Add Package Dependencies…` and input the package URL:
3734

38-
Or, for SPM-based projects, add it to your package dependencies and target dependency:
35+
> `https://github.com/gohanlon/swift-memberwise-init-macro`
3936
40-
```swift
41-
.package(
42-
url: "https://github.com/gohanlon/swift-memberwise-init-macro",
43-
branch: "main" // NB: tagged release forthcoming
44-
),
45-
```
37+
Or, for SPM-based projects, add it to your package dependencies:
4638

4739
```swift
4840
dependencies: [
49-
.product(name: "MemberwiseInit", package: "swift-memberwise-init-macro"),
41+
.package(url: "https://github.com/gohanlon/swift-memberwise-init-macro", from: "0.1.0")
5042
]
5143
```
5244

45+
And then add the product to all targets that use MemberwiseInit:
46+
47+
```swift
48+
.product(name: "MemberwiseInit", package: "swift-memberwise-init-macro"),
49+
```
50+
5351
2. **Import & basic usage**
5452
<br> After importing MemberwiseInit, add `@MemberwiseInit` before your type definition. This will mirror Swift’s behavior: it provides an initializer with up to internal access, but scales down if any properties are more restrictive. Here, `age` being private makes the initializer private too:
5553

0 commit comments

Comments
 (0)