Skip to content

docs: create readmes for new kit flow#596

Open
nickolas-dimitrakas wants to merge 6 commits intoworkstation/9.0-Releasefrom
docs/create-readmes-for-new-kit-flow
Open

docs: create readmes for new kit flow#596
nickolas-dimitrakas wants to merge 6 commits intoworkstation/9.0-Releasefrom
docs/create-readmes-for-new-kit-flow

Conversation

@nickolas-dimitrakas
Copy link
Contributor

Background

  • This PR starts a standardized README approach for kit directories so we have a consistent structure going forward

What Has Changed

  • Added/updated README content to establish a reusable format for kit documentation.
  • Defined the baseline structure we will follow for all future kits added to this repository.

Checklist

  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have tested this locally.

Reference Issue (For employees only. Ignore if you are an outside contributor)

@nickolas-dimitrakas nickolas-dimitrakas self-assigned this Feb 17, 2026
@nickolas-dimitrakas nickolas-dimitrakas marked this pull request as ready for review February 17, 2026 20:50
@nickolas-dimitrakas nickolas-dimitrakas requested a review from a team as a code owner February 17, 2026 20:50
@github-actions
Copy link

github-actions bot commented Feb 17, 2026

📦 SDK Size Impact Report

Measures how much the SDK adds to an app's size (with-SDK minus without-SDK).

Metric Target Branch This PR Change
App Bundle Impact 1.66 MB 1.66 MB +N/A
Executable Impact 896 bytes 896 bytes +N/A
XCFramework Size 5.47 MB 5.47 MB +N/A

➡️ SDK size impact change is minimal.

Raw measurements

Target branch (workstation/9.0-Release):

{"baseline_app_size_kb":84,"baseline_executable_size_bytes":75464,"with_sdk_app_size_kb":1788,"with_sdk_executable_size_bytes":76360,"sdk_impact_kb":1704,"sdk_executable_impact_bytes":896,"xcframework_size_kb":5604}

This PR:

{"baseline_app_size_kb":84,"baseline_executable_size_bytes":75464,"with_sdk_app_size_kb":1788,"with_sdk_executable_size_bytes":76360,"sdk_impact_kb":1704,"sdk_executable_impact_bytes":896,"xcframework_size_kb":5604}

@nickolas-dimitrakas nickolas-dimitrakas marked this pull request as draft February 17, 2026 23:13
@nickolas-dimitrakas nickolas-dimitrakas marked this pull request as ready for review February 17, 2026 23:23
## Installation

1. Add the kit dependency using SPM:
> **Viewing this from the monorepo?** Add the kit as a dependency from the [mparticle-integrations/mparticle-apple-integration-braze-12](https://github.com/mparticle-integrations/mparticle-apple-integration-braze-12) repository, not from the monorepo path.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Probably doesn't need to be said. Whether you're on the mono repo or the integrations site the install instructions are the same

url: "https://github.com/mparticle-integrations/mparticle-apple-integration-braze-12",
.upToNextMajor(from: mParticleVersion)
),
.package(
Copy link
Contributor

Choose a reason for hiding this comment

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

When partners integrate Kit with SMP they don't need to additionally set a dependency from mParticle it should be resolved automatically.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants