51 lines
2.3 KiB
Markdown
51 lines
2.3 KiB
Markdown
<!--
|
|
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`. Lightweight app analytics / fan-engagement tracking with a durable offline queue, consent gating, and Auth0 JWT support.
|
|
|
|
> This repo hosts the **consumable artifacts** (release assets + package manifests). The SDK source lives in 3 Halves Labs' private platform repo.
|
|
|
|
## Install — 0.5.0 (no token / login required)
|
|
|
|
### iOS — Swift Package Manager
|
|
Add this repo by git URL. There's no registry to configure and no login.
|
|
```swift
|
|
// Package.swift
|
|
dependencies: [ .package(url: "https://git.3halves-labs.com/3HL-SCORE/public-sdks-score.git", from: "0.5.0") ]
|
|
// target: .product(name: "ScoreTracker", package: "public-sdks-score")
|
|
```
|
|
Or in Xcode: **File → Add Packages…** and paste the URL. (The old Swift package
|
|
*registry* route, `threehalveslabs.ScoreTracker`, was retired; that package no
|
|
longer exists.)
|
|
|
|
### iOS — CocoaPods
|
|
```ruby
|
|
pod 'ScoreTracker',
|
|
:podspec => 'https://git.3halves-labs.com/3HL-SCORE/public-sdks-score/raw/branch/main/ScoreTracker.podspec'
|
|
```
|
|
|
|
### iOS — direct XCFramework
|
|
Download `ScoreTracker-pod.zip` from the [`mobile-v0.5.0` release](https://git.3halves-labs.com/3HL-SCORE/public-sdks-score/releases). It contains `ScoreTrackerKit.xcframework` plus the Swift facade sources (`Sources/ScoreTracker/`). Drag the framework into Xcode and add the Swift files to your app target.
|
|
|
|
### Android — Gradle
|
|
```kotlin
|
|
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.5.0")
|
|
}
|
|
```
|
|
|
|
## Quickstart & API
|
|
|
|
See the full integration guide (init, consent, Auth0, offline/flush, event catalogue): **`INTEGRATION.md`** in this repo (published alongside each release).
|
|
|
|
## Support
|
|
|
|
Issues / integration questions: contact 3 Halves Labs. Versions are tagged `mobile-v<version>`.
|