Skip to content

docs: add installation instructions to README - #8662

Open
itaybre wants to merge 2 commits into
mainfrom
docs/readme-installation-instructions
Open

docs: add installation instructions to README#8662
itaybre wants to merge 2 commits into
mainfrom
docs/readme-installation-instructions

Conversation

@itaybre

@itaybre itaybre commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Description

Add inline installation instructions to the README so users can get started without leaving the repo. Covers:

  • Sentry Wizard — recommended one-liner for automatic setup
  • Swift Package Manager — Xcode UI steps and Package.swift snippet
  • Pre-built XCFrameworks — link to GitHub Releases
  • Link to full docs for additional options (Objective-C, dynamic linking, manual install)

Closes COCOA-1431

#skip-changelog

Add inline installation steps for Sentry Wizard, Swift Package
Manager (Xcode UI and Package.swift), and pre-built XCFrameworks
so users can get started without leaving the repo.
@linear-code

linear-code Bot commented Aug 3, 2026

Copy link
Copy Markdown

COCOA-1431

Point users to sentry-apple-binaries for pre-built static
binaries and clarify this repo is for compiling from source.
Comment thread README.md
],
targets: [
.target(name: "YourApp", dependencies: [
.product(name: "SentrySPM", package: "sentry-cocoa"),

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once we have v10, this will be renamed to Sentry

@itaybre itaybre added the run-full-ci Allows gated GitHub Action workflows to run for a labelled pull request label Aug 4, 2026
@itaybre
itaybre marked this pull request as ready for review August 4, 2026 18:55

@philprime philprime left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved run-full-ci Allows gated GitHub Action workflows to run for a labelled pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants