Skip to content

Commit 57fd293

Browse files
committed
README: Added Requirements and Installation sections
1 parent 86abddc commit 57fd293

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,37 @@ This is a continuation and modernization of [Peter Steinberger’s original impl
1919
- There’s no runtime type checking, and the signature has to be written twice—a trade-off to avoid `NSInvocation`.
2020
- Written almost entirely in Swift on top of the Objective-C runtime[^2].
2121

22+
## Requirements
23+
24+
- Swift 5.9 or later
25+
- Xcode 15 or later
26+
- Apple platforms only (macOS, iOS, tvOS, watchOS)
27+
- arm64 or x86_64 architectures
28+
2229
## Installation
2330

24-
- Installation Swift Package Manager
25-
- Swift 5.9+, Xcode 15+
26-
- arm64 and x86_64 architectures
31+
You can add InterposeKit to your project using the Swift Package Manager.
32+
33+
In Xcode, open your project settings, select the *Package Dependencies* tab, click the *+* button, and enter the URL `https://github.com/structuredpath/InterposeKit`. Then select the latest version and add the package to your desired target.
34+
35+
If you’re adding InterposeKit using a `Package.swift` manifest, include it in your `dependencies` like this:
36+
37+
```swift
38+
dependencies: [
39+
.package(url: "https://github.com/structuredpath/InterposeKit", from: "1.0.0")
40+
]
41+
```
42+
43+
Then add the product to any target that needs it:
44+
45+
```swift
46+
.target(
47+
name: "YourTarget",
48+
dependencies: [
49+
.product(name: "InterposeKit", package: "InterposeKit")
50+
]
51+
)
52+
```
2753

2854
## Usage
2955

0 commit comments

Comments
 (0)