mosaic/telemetry-client-js
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(#1): document dev/release package versioning convention
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details

Browse Source 
Add versioning table to README and integration guide showing dist-tags,
version formats, and .npmrc registry configuration for the Gitea npm
registry.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Jason Woltje
2026-02-14 23:02:46 -06:00
parent 0b0fb9ab7b
commit 20f56edb49
2 changed files with 38 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -9,9 +9,28 @@ TypeScript client SDK for [Mosaic Stack Telemetry](https://tel.mosaicstack.dev).
## Installation ## Installation
```bash ```bash
# Latest stable release (from main)
npm install @mosaicstack/telemetry-client 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 ## Quick Start
```typescript ```typescript

21
docs/integration-guide.md
View File

@@ -9,10 +9,27 @@ This guide covers how to integrate `@mosaicstack/telemetry-client` into your app
## Installation ## Installation
```bash Configure the Gitea npm registry in your project's `.npmrc`:
npm install @mosaicstack/telemetry-client
```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. The package ships ESM-only with TypeScript declarations. Zero runtime dependencies.
## Environment Setup ## Environment Setup