Skip to content

Commit 61f478f

Browse files
authored
Add usage part in README (#153)
1 parent 7ba2f93 commit 61f478f

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,26 @@ The project is for the following purposes:
2525

2626
Currently, this project is in early development.
2727

28+
## Usage
29+
30+
### Via Swift Package Manager
31+
32+
Add OpenGraph as a dependency in your `Package.swift`:
33+
34+
```swift
35+
dependencies: [
36+
.package(url: "https://github.com/OpenSwiftUIProject/OpenGraph.git", from: "0.2.0")
37+
]
38+
```
39+
40+
> [!NOTE]
41+
> - You may need to configure the Swift toolchain header for proper integration of OpenGraph
42+
> - By default, OpenGraphShims will use the private AttributeGraph as its implementation on Apple platforms
43+
44+
### Via Prebuilt XCFramework
45+
46+
For a simpler setup, you can use the prebuilt XCFramework available on the [releases page](https://github.com/OpenSwiftUIProject/OpenGraph/releases).
47+
2848
## Build
2949

3050
The current suggested toolchain to build the project is Swift 6.1.2 / Xcode 16.4.

0 commit comments

Comments
 (0)