diff --git a/CHANGELOG.md b/CHANGELOG.md index 816d7a5..501e626 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,9 @@ All notable changes to this project are documented here. The format is based on `PUBLISH_REGISTRY` variable on a tag push (npm when unset), and reports a version a registry already has instead of failing. `.dev/tools/npm-release github|npm` publishes every missing release; see `docs/release.md`. +- **The install docs say where Tabar is published.** 0.5.0 and 0.6.0 are on GitHub Packages, + which needs a scoped `.npmrc` and a `read:packages` token; the README and + `docs/installation.md` show both, and note that the CDN links resolve only once Tabar is on npm. - **Configurable border** — `borderWidth`/`borderStyle`/`borderColor` (and `setBorder`) outline the linear track; `--tabar-border-*` CSS vars; settable via ``/`data-tabar-*`. - **Broader, consistent API.** New chainable setters — `setSize`, `setShape` diff --git a/README.md b/README.md index 395e0fe..a75f3e5 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,19 @@ bar.done(); // glide to 100%, then hide npm install @simtabi/tabar ``` +`@simtabi/tabar` is published to GitHub Packages, not npm, for now. GitHub Packages asks for a +token even for a public package, so before `npm install` add a GitHub token with `read:packages` to +the project's `.npmrc`: + +```ini +@simtabi:registry=https://npm.pkg.github.com +//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN} +``` + +> The CDN links below serve from npm (jsDelivr and unpkg read the npm registry), and Tabar is on +> GitHub Packages only for now, so they resolve once it is published to npm. Until then, install it +> as above and bundle it, or serve `dist/` from your own build. + Or drop in the ready-to-use script from a CDN — exposes a global `Tabar`, no build step: ```html diff --git a/docs/installation.md b/docs/installation.md index e30eb74..a03e880 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -9,6 +9,15 @@ plain `