Skip to content

docs: add installation instructions to README #8662

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
itaybre merged 2 commits into from
Aug 5, 2026
Merged

docs: add installation instructions to README #8662

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bc2665
docs: add installation instructions to README
itaybre Aug 3, 2026
95d77a8
docs: clarify pre-built vs compile-from-source install
itaybre Aug 3, 2026
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
42 changes: 39 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,46 @@ _Bad software is everywhere, and we're tired of it. Sentry is on a mission to he

# Installation

SPM is the recommended way to include Sentry into your project.
We also provide pre-built XCFrameworks on [our GitHub Releases page](https://github.com/getsentry/sentry-cocoa/releases).
### Sentry Wizard (Recommended)

To see all available installation options and how to integrate Sentry into your project, please refer to our [documentation](https://docs.sentry.io/platforms/apple/install/).
The quickest way to get started:

```bash
brew install getsentry/tools/sentry-wizard && sentry-wizard -i ios
```

This patches your project and configures the SDK automatically.

### Swift Package Manager (Compile from Source)

Use this repository to build the SDK from source:

**In Xcode:** File > Add Packages, then paste:

```
https://github.com/getsentry/sentry-cocoa.git
```

**In `Package.swift`:**

```swift
dependencies: [
.package(url: "https://github.com/getsentry/sentry-cocoa", from: "9.24.0"),
],
targets: [
.target(name: "YourApp", dependencies: [
.product(name: "SentrySPM", package: "sentry-cocoa"),
Comment thread
itaybre marked this conversation as resolved.
]),
]
```

### Pre-built XCFrameworks

For pre-built static binaries via SPM, use the [sentry-apple-binaries](https://github.com/getsentry/sentry-apple-binaries) repository.

You can also download XCFrameworks directly from [GitHub Releases](https://github.com/getsentry/sentry-cocoa/releases).

For all installation options (Objective-C, dynamic linking, manual install), see the [full installation docs](https://docs.sentry.io/platforms/apple/install/).

> [!NOTE]
> CocoaPods support has been dropped. The last version available via CocoaPods is [9.19.1](https://github.com/getsentry/sentry-cocoa/releases/tag/9.19.1). Please migrate to SPM or XCFrameworks.
Expand Down
Loading