From 59a33a7bc5ba163d90f723c642e2715905c768dc Mon Sep 17 00:00:00 2001 From: Aric Camarata Date: Tue, 30 Jun 2026 15:00:14 -0400 Subject: [PATCH] add opt-in telemetry via @acamarata/telemetry (off by default) --- README.md | 5 +++++ TELEMETRY.md | 8 ++++++++ package.json | 3 ++- src/index.ts | 11 +++++++++++ 4 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 TELEMETRY.md diff --git a/README.md b/README.md index ebf9048..2b622cc 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/TELEMETRY.md b/TELEMETRY.md new file mode 100644 index 0000000..99cfaa4 --- /dev/null +++ b/TELEMETRY.md @@ -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) diff --git a/package.json b/package.json index b738d59..28ef372 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/src/index.ts b/src/index.ts index 58017bf..4b64d35 100644 --- a/src/index.ts +++ b/src/index.ts @@ -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 + });