Skip to content

Commit 67b3e94

Browse files
committed
feat: Update README.md
1 parent 784c955 commit 67b3e94

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -323,41 +323,36 @@ let kp_unwrapped: KeyPath<Root, Int> = kp_combined.unwrapped(with: 0)
323323
>
324324
> _`KeyPathsOptionalTests.ReferenceTypeInReferenceType.aggressivelyUnwrapped()` contains a note, mentioning that aggressive unwrapping is not guaranteed for nested reference types, at least when such unwrapped paths are combined with some other ones_
325325
326+
> [!Tip]
327+
>
328+
> `KeyPathsExtensions` also provide "_Sendable"-prefixed keyPath aliases and `unsafeSendable()` methods.
329+
326330
## Installation
327331

328332
### Basic
329333

330-
You can add KeypathsExtensions to an Xcode project by adding it as a package dependency.
334+
You can add `swift-keypaths-extensions` to an Xcode project by adding it as a package dependency.
331335

332336
1. From the **File** menu, select **Swift Packages › Add Package Dependency…**
333337
2. Enter [`"https://github.com/capturecontext/swift-keypaths-extensions"`](https://github.com/capturecontext/swift-keypaths-extensions) into the package repository URL text field
334-
3. Choose products you need to link them to your project.
338+
3. Choose products you need to link to your project.
335339

336340
### Recommended
337341

338-
If you use SwiftPM for your project structure, add KeyPathsExtensions to your package file.
339-
340-
```swift
341-
.package(
342-
url: "https://github.com/capturecontext/swift-keypaths-extensions.git",
343-
.upToNextMinor(from: "0.1.0")
344-
)
345-
```
346-
347-
or via HTTPS
342+
If you use SwiftPM for your project structure, add `swift-keypaths-extensions` dependency to your package file
348343

349344
```swift
350345
.package(
351346
url: "https://github.com/capturecontext/swift-keypaths-extensions.git",
352-
.upToNextMinor("0.1.0")
347+
.upToNextMinor("0.1.9")
353348
)
354349
```
355350

356-
Do not forget about target dependencies:
351+
Do not forget about target dependencies
357352

358353
```swift
359354
.product(
360-
name: "KeyPathsExtensions",
355+
name: "<#Product#>",
361356
package: "swift-keypaths-extensions"
362357
)
363358
```

0 commit comments

Comments
 (0)