From aa93defe9dd42c01ce4b961cb16bccce790ed2ad Mon Sep 17 00:00:00 2001 From: ImmutableJeffrey Date: Thu, 30 Apr 2026 15:03:14 +1000 Subject: [PATCH] docs(audience): add UPM-visible README for the Audience package (SDK-150) Adds src/Packages/Audience/README.md so studios clicking the package in Unity Package Manager see install instructions, a working first-event snippet, and a link to the full integration guide on docs.immutable.com. --- src/Packages/Audience/README.md | 52 ++++++++++++++++++++++++++++++ src/Packages/Audience/package.json | 4 ++- 2 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 src/Packages/Audience/README.md diff --git a/src/Packages/Audience/README.md b/src/Packages/Audience/README.md new file mode 100644 index 000000000..81891a954 --- /dev/null +++ b/src/Packages/Audience/README.md @@ -0,0 +1,52 @@ +# Immutable Audience + +Typed C# tracking SDK for Unity games. Captures `game_launch`, `session_start` / `session_heartbeat` / `session_end` automatically; predefined events (`Progression`, `Resource`, `Purchase`, `MilestoneReached`) and custom events on demand. + +> **Status:** alpha. APIs and behavior may change between releases. + +## Install + +In Unity, open **Window → Package Manager**, click **+ → Add package from git URL...**, and paste: + +``` +https://github.com/immutable/unity-immutable-sdk.git?path=src/Packages/Audience#main +``` + +For reproducible builds, replace `#main` with a release tag or a specific commit SHA. + +Requires Unity 2021.3 or later. Works under Mono and IL2CPP. + +## First event + +```csharp +using Immutable.Audience; +using UnityEngine; + +public static class Analytics +{ + [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] + private static void Init() + { + ImmutableAudience.Init(new AudienceConfig + { + PublishableKey = "YOUR_PUBLISHABLE_KEY", + Consent = ConsentLevel.Anonymous, + DistributionPlatform = DistributionPlatforms.Steam, + Debug = true, + }); + + ImmutableAudience.Track(new Purchase { Currency = "USD", Value = 9.99m }); + } +} +``` + +Press Play; `ImmutableAudience.Initialized` returns `true` and `AnonymousId` becomes a non-null GUID. The SDK warns to the Unity Console with prefix `[ImmutableAudience]` only on errors. + +## Documentation + +- Integration guide and API reference: +- Sample Unity project: [`examples/audience`](https://github.com/immutable/unity-immutable-sdk/tree/main/examples/audience) + +## License + +See the repository [LICENSE](https://github.com/immutable/unity-immutable-sdk/blob/main/LICENSE.md). diff --git a/src/Packages/Audience/package.json b/src/Packages/Audience/package.json index e6b8e96fb..59e752bd8 100644 --- a/src/Packages/Audience/package.json +++ b/src/Packages/Audience/package.json @@ -5,5 +5,7 @@ "displayName": "Immutable Audience", "author": {"name": "Immutable", "url": "https://immutable.com"}, "keywords": ["unity", "immutable", "audience", "analytics"], - "unity": "2021.3" + "unity": "2021.3", + "documentationUrl": "https://docs.immutable.com/docs/products/audience/unity-sdk", + "licensesUrl": "https://github.com/immutable/unity-immutable-sdk/blob/main/LICENSE.md" }