Skip to content

Commit 9b3b3c1

Browse files
authored
Refactor README for clarity and add workflow links (#827)
Updated the README to improve section formatting and added links to GitHub actions workflows for Android and iOS.
1 parent 94f74f6 commit 9b3b3c1

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,23 @@ The iOS app is available on the [App Store](https://apps.apple.com/us/app/hacker
2020
[Android docs](https://docs.sentry.io/platforms/android/)
2121
[Apple docs](https://docs.sentry.io/platforms/apple/)
2222

23-
### Example setup
23+
### Example Setup
2424

25-
**Android:** The Android project in this repo uses the [Sentry Gradle Plugin](https://docs.sentry.io/platforms/android/configuration/gradle/) to upload to Sentry. Check out the [build.gradle.kts](android/app/build.gradle.kts) for an example configuration.
25+
This project uses the following GitHub actions workflows to upload builds and snapshot images to Sentry:
2626

27-
**iOS**: The iOS project in this repo uses _[fastlane](https://github.com/getsentry/sentry-fastlane-plugin)_ to upload to Sentry. Check out the [Fastfile](ios/fastlane/Fastfile) for an example configuration.
27+
**Android:**
28+
- [Snapshots](.github/workflows/android_sentry_upload_snapshots.yml)
29+
- [Size analysis](.github/workflows/android_sentry_size_analysis.yml)
30+
- [Distribution](.github/workflows/android_beta_build.yml)
31+
32+
The Android project in this repo uses the [Sentry Gradle Plugin](https://docs.sentry.io/platforms/android/configuration/gradle/) to upload to Sentry. Check out the [build.gradle.kts](android/app/build.gradle.kts) for an example configuration.
33+
34+
**iOS:**
35+
- [Snapshots](.github/workflows/ios_sentry_upload_snapshots.yml)
36+
- [Size analysis](.github/workflows/ios_sentry_upload_pr.yml)
37+
- [Distribution](.github/workflows/ios_sentry_upload_adhoc.yml)
38+
39+
The iOS project in this repo uses _[fastlane](https://github.com/getsentry/sentry-fastlane-plugin)_ to upload to Sentry. Check out the [Fastfile](ios/fastlane/Fastfile) for an example configuration.
2840

2941
## Questions
3042

0 commit comments

Comments
 (0)