diff --git a/README.md b/README.md index d69fb35..189f532 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,28 @@ TypeScript client SDK for [Mosaic Stack Telemetry](https://tel.mosaicstack.dev). ## Installation ```bash +# Latest stable release (from main) npm install @mosaicstack/telemetry-client + +# Latest dev build (from develop) +npm install @mosaicstack/telemetry-client@dev ``` +The Gitea npm registry must be configured in `.npmrc`: + +```ini +@mosaicstack:registry=https://git.mosaicstack.dev/api/packages/mosaic/npm/ +``` + +### Versioning + +| Branch | Dist-tag | Version format | Example | +|--------|----------|----------------|---------| +| `main` | `latest` | `{version}` | `0.1.0` | +| `develop` | `dev` | `{version}-dev.{YYYYMMDDHHmmss}` | `0.1.0-dev.20260215050000` | + +Every push to `develop` publishes a new prerelease. Stable releases publish from `main` only when the version in `package.json` changes. + ## Quick Start ```typescript diff --git a/docs/integration-guide.md b/docs/integration-guide.md index aa5208c..5dcc8ca 100644 --- a/docs/integration-guide.md +++ b/docs/integration-guide.md @@ -9,10 +9,27 @@ This guide covers how to integrate `@mosaicstack/telemetry-client` into your app ## Installation -```bash -npm install @mosaicstack/telemetry-client +Configure the Gitea npm registry in your project's `.npmrc`: + +```ini +@mosaicstack:registry=https://git.mosaicstack.dev/api/packages/mosaic/npm/ ``` +Then install: + +```bash +# Latest stable release (from main) +npm install @mosaicstack/telemetry-client + +# Latest dev build (from develop) +npm install @mosaicstack/telemetry-client@dev +``` + +| Branch | Dist-tag | Version format | Example | +|--------|----------|----------------|---------| +| `main` | `latest` | `{version}` | `0.1.0` | +| `develop` | `dev` | `{version}-dev.{YYYYMMDDHHmmss}` | `0.1.0-dev.20260215050000` | + The package ships ESM-only with TypeScript declarations. Zero runtime dependencies. ## Environment Setup