Skip to content

Commit 8a9113c

Browse files
docs(audience): add @imtbl/audience README (SDK-115)
- Adds packages/audience/sdk/README.md (no README existed before this). - Documents both distribution channels: npm install for sites with a bundler, and `<script>` tag with the unpkg interim URL for sites without a build pipeline. - Stubs the future cdn.immutable.com canonical URL with a note that the v1 lane will ship breaking changes only via v2. - Covers init, full API table, AudienceConfig, consent modes, predefined event types, CSP guidance, and browser support. - Reframes the @imtbl/pixel related-package note: distinction is feature surface (full SDK vs minimal pixel), not delivery channel — both packages support npm and `<script>` tag. Refs SDK-115
1 parent 42565f8 commit 8a9113c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

packages/audience/sdk/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# About
2+
3+
Immutable Audience is a consent-aware event tracking SDK for game studios. It captures player activity on your website — page views, sign-ups, purchases, and game launches — and ties it to player identity when they sign in, feeding Immutable's events pipeline.
4+
5+
### Documentation
6+
7+
- [Tracking Pixel](https://docs.immutable.com/docs/products/audience/tracking-pixel) — sibling `@imtbl/pixel` package for drop-in page-view tracking
8+
- [Web SDK](https://docs.immutable.com/docs/products/audience/web-sdk) — this package (API reference, usage, integration walkthrough)
9+
- [REST API](https://docs.immutable.com/docs/products/audience/rest-api) — backend reference for direct integration
10+
- [Data dictionary](https://docs.immutable.com/docs/products/audience/data-dictionary) — predefined event names and property schemas
11+
12+
# Installation
13+
14+
To install this package, run the following command:
15+
16+
```sh
17+
npm add @imtbl/audience
18+
# or
19+
pnpm add @imtbl/audience
20+
# or
21+
yarn add @imtbl/audience
22+
```

0 commit comments

Comments
 (0)