Publish Score iOS SDK 0.2.0
This commit is contained in:
38
README.md
38
README.md
@@ -1,14 +1,24 @@
|
||||
<!--
|
||||
Seed README for the PUBLIC distribution repo `3HL-SCORE/public-sdks-score` (#284).
|
||||
Copy this to that repo's root as README.md when publishing. Source of truth for
|
||||
the SDK lives in the private score-anything-loyalty repo under `mobile/`.
|
||||
-->
|
||||
# Score mobile SDKs (public distribution)
|
||||
|
||||
Public, auth-free distribution of the **Score mobile tracker** SDKs for iOS and Android — the mobile counterpart of the web `@3halves-labs/score-tracker`.
|
||||
Public, auth-free distribution of the **Score mobile tracker** SDKs for iOS and Android — the mobile counterpart of the web `@3halves-labs/score-tracker`. Lightweight app analytics / fan-engagement tracking with a durable offline queue, consent gating, and Auth0 JWT support.
|
||||
|
||||
## Install — 0.1.0 (no token / login required)
|
||||
> This repo hosts the **consumable artifacts** (release assets + package manifests). The SDK source lives in 3 Halves Labs' private platform repo.
|
||||
|
||||
### iOS — Swift Package Manager (git URL)
|
||||
## Install — 0.2.0 (no token / login required)
|
||||
|
||||
### iOS — Swift Package Manager
|
||||
```bash
|
||||
swift package-registry set https://git.3halves-labs.com/api/packages/3HL-SCORE/swift
|
||||
```
|
||||
```swift
|
||||
// Package.swift
|
||||
dependencies: [ .package(url: "https://git.3halves-labs.com/3HL-SCORE/public-sdks-score.git", from: "0.1.0") ]
|
||||
// target: .product(name: "ScoreTracker", package: "public-sdks-score")
|
||||
dependencies: [ .package(id: "threehalveslabs.ScoreTracker", from: "0.2.0") ]
|
||||
// target: .product(name: "ScoreTracker", package: "ScoreTracker")
|
||||
```
|
||||
|
||||
### iOS — CocoaPods
|
||||
@@ -18,16 +28,22 @@ pod 'ScoreTracker',
|
||||
```
|
||||
|
||||
### iOS — direct XCFramework
|
||||
Download `ScoreTrackerKit.xcframework.zip` from the [`mobile-v0.1.0` release](https://git.3halves-labs.com/3HL-SCORE/public-sdks-score/releases) and drag it into Xcode.
|
||||
Download `ScoreTrackerKit.xcframework.zip` from the [`mobile-v0.2.0` release](https://git.3halves-labs.com/3HL-SCORE/public-sdks-score/releases) and drag it into Xcode.
|
||||
|
||||
### Android — Gradle
|
||||
```kotlin
|
||||
repositories { maven { url = uri("https://git.3halves-labs.com/api/packages/3HL-SCORE/maven") } } // public
|
||||
dependencies { implementation("com.threehalveslabs.scoretracker:shared-android:0.1.0") }
|
||||
repositories {
|
||||
maven { url = uri("https://git.3halves-labs.com/api/packages/3HL-SCORE/maven") } // public — no credentials
|
||||
}
|
||||
dependencies {
|
||||
implementation("com.threehalveslabs.scoretracker:shared-android:0.2.0")
|
||||
}
|
||||
```
|
||||
|
||||
## Docs
|
||||
## Quickstart & API
|
||||
|
||||
Full integration guide (init, consent, Auth0, offline/flush, event catalogue): **[`INTEGRATION.md`](INTEGRATION.md)**.
|
||||
See the full integration guide (init, consent, Auth0, offline/flush, event catalogue): **`INTEGRATION.md`** in this repo (published alongside each release).
|
||||
|
||||
SDK source lives in 3 Halves Labs' platform repo; this repo hosts the consumable artifacts. Versions tagged `0.1.0` (SPM) / `mobile-v0.1.0` (release asset).
|
||||
## Support
|
||||
|
||||
Issues / integration questions: contact 3 Halves Labs. Versions are tagged `mobile-v<version>`.
|
||||
|
||||
Reference in New Issue
Block a user