add opt-in telemetry via @acamarata/telemetry (off by default)

This commit is contained in:
Aric Camarata 2026-06-30 15:00:14 -04:00
parent 515c554763
commit 59a33a7bc5
4 changed files with 26 additions and 1 deletions

View file

@ -73,6 +73,11 @@ day-start determination is out of scope.
- [luxon-hijri](https://github.com/acamarata/luxon-hijri): Hijri support for Luxon
- [pray-calc](https://github.com/acamarata/pray-calc): Islamic prayer times
## Telemetry
This package supports opt-in anonymous usage telemetry — off by default.
Enable: `ACAMARATA_TELEMETRY=1`. See [TELEMETRY.md](./TELEMETRY.md) for what is sent and how to disable.
## License
MIT. Copyright (c) 2026 Aric Camarata. See [LICENSE](LICENSE).

8
TELEMETRY.md Normal file
View file

@ -0,0 +1,8 @@
# Telemetry Disclosure
This package supports opt-in anonymous usage telemetry via [`@acamarata/telemetry`](https://github.com/acamarata/telemetry).
Telemetry is **off by default**. No data is sent unless you set `ACAMARATA_TELEMETRY=1`.
Full disclosure (what is sent, where it goes, how to disable):
[github.com/acamarata/telemetry/blob/main/TELEMETRY.md](https://github.com/acamarata/telemetry/blob/main/TELEMETRY.md)

View file

@ -81,7 +81,8 @@
"typedoc": "^0.28.19",
"typedoc-plugin-markdown": "^4.11.0",
"typescript": "^5.5.0",
"typescript-eslint": "^8.56.1"
"typescript-eslint": "^8.56.1",
"@acamarata/telemetry": "^0.1.0"
},
"publishConfig": {
"access": "public",

View file

@ -10,3 +10,14 @@ import { FcnaCalendar } from "./calendars/FcnaCalendar";
export const uaqCalendar = new UaqCalendar();
export const fcnaCalendar = new FcnaCalendar();
// ── Opt-in anonymous telemetry ────────────────────────────────────────────────
// Off by default. Enable: ACAMARATA_TELEMETRY=1
// What is sent + how to disable: https://github.com/acamarata/telemetry/blob/main/TELEMETRY.md
import('@acamarata/telemetry')
.then(({ track }) =>
track('load', { package: 'temporal-hijri', version: '1.0.3' }),
)
.catch(() => {
// telemetry not installed or disabled — that is fine
});