Skip to content

Add usage part in README #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kyle-Ye merged 1 commit into from
Aug 3, 2025
Merged

Add usage part in README #153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,26 @@ The project is for the following purposes:

Currently, this project is in early development.

## Usage

### Via Swift Package Manager

Add OpenGraph as a dependency in your `Package.swift`:

```swift
dependencies: [
.package(url: "https://github.com/OpenSwiftUIProject/OpenGraph.git", from: "0.2.0")
]
```

> [!NOTE]
> - You may need to configure the Swift toolchain header for proper integration of OpenGraph
> - By default, OpenGraphShims will use the private AttributeGraph as its implementation on Apple platforms

### Via Prebuilt XCFramework

For a simpler setup, you can use the prebuilt XCFramework available on the [releases page](https://github.com/OpenSwiftUIProject/OpenGraph/releases).

## Build

The current suggested toolchain to build the project is Swift 6.1.2 / Xcode 16.4.
Expand Down
Loading