@michaelyagi/shoji 0.1.0-beta.1 → 0.1.0-beta.12

package/README.md

@@ -1,11 +1,11 @@
 # Shoji
 
 [![CI](https://github.com/MichaelYagi/shoji/actions/workflows/ci.yml/badge.svg)](https://github.com/MichaelYagi/shoji/actions/workflows/ci.yml)
-[![npm (alpha)](https://img.shields.io/npm/v/%40michaelyagi%2Fshoji/alpha.svg)](https://www.npmjs.com/package/@michaelyagi/shoji)
+[![npm (beta)](https://img.shields.io/npm/v/%40michaelyagi%2Fshoji/beta.svg)](https://www.npmjs.com/package/@michaelyagi/shoji)
 
-A zero-dependency, plugin-first TypeScript lightbox/gallery. Drop in two `<script>`/`<link>` tags, or install from npm — everything beyond the minimal lightbox, including every official plugin, is opt-in.
+> **AI-authored.** 100% of the code was written by Claude (Anthropic); I shaped the architecture, scope, and every decision, and did all the testing.
 
-> **Status: alpha.** The API is still settling — expect breaking changes between `0.x` releases.
+A zero-dependency, plugin-first TypeScript lightbox/gallery. Drop in two `<script>`/`<link>` tags, or install from npm — everything beyond the minimal lightbox, including every official plugin, is opt-in.
 
 ## Features
 
@@ -14,7 +14,7 @@ A zero-dependency, plugin-first TypeScript lightbox/gallery. Drop in two `<scrip
 - **Plugin system** — zoom (pinch/pan/wheel), fullscreen, rotate/flip, autoplay/slideshow, active-thumbnail sync, YouTube video embeds, and a grid/masonry/justified layout engine, each independently opt-in.
 - **Accessibility is not a plugin** — keyboard nav, focus trapping, ARIA roles, and screen-reader announcements live in core.
 - **Themeable via CSS custom properties** — no hardcoded colors/sizes in JS.
-- **Single-file distribution** — `dist/shoji.js` + `dist/shoji.css` (core + every official plugin, self-registering) for zero-setup `<script>` tag use, plus tree-shakable per-plugin ESM entries for bundler users.
+- **Three distributions** — single-file (`dist/shoji.js` + `dist/shoji.css`, core + every plugin, self-registering) for zero-setup `<script>` tag use; core + individual plugin files (`dist/core/shoji-core.(min.)js` + `dist/plugins/{name}.(min.)js`) for `<script>`-tag consumers who want to pick exactly which plugins ship; and tree-shakable per-plugin ESM entries for bundler users.
 - Size-budgeted and CI-enforced: core ≤ 21 kB, each plugin ≤ 8 kB, full bundle ≤ 90 kB (all min+gzip).
 
 ## Install
@@ -28,7 +28,7 @@ A zero-dependency, plugin-first TypeScript lightbox/gallery. Drop in two `<scrip
 ```
 
 ```bash
-npm install @michaelyagi/shoji@alpha
+npm install @michaelyagi/shoji@beta
 ```
 
 ```js
@@ -38,6 +38,25 @@ import '@michaelyagi/shoji/style.css';
 new Shoji('#gallery', { plugins: [Shoji.Zoom] });
 ```
 
+## CDN
+
+Skip npm and load the built files straight from [jsDelivr](https://www.jsdelivr.net/), which mirrors every npm release automatically:
+
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@michaelyagi/shoji/dist/shoji.min.css" />
+<script src="https://cdn.jsdelivr.net/npm/@michaelyagi/shoji/dist/shoji.min.js"></script>
+```
+
+- **Full bundle** (core + every plugin) — `dist/shoji.min.js` / `dist/shoji.min.css`, or unminified: `dist/shoji.js` / `dist/shoji.css`.
+- **Core alone** — `dist/core/shoji-core.min.js` + `dist/core/shoji-core.min.css`.
+- **Individual plugins**, loaded alongside core — `dist/plugins/<name>.min.js`, e.g. `zoom.min.js`, `layout.min.js`. Not every plugin ships CSS: `activeThumbnail`, `autoplay`, `layout`, and `zoom` do; `fullscreen`, `rotateFlip`, and `video` don't need any.
+
+No version in the URL resolves to the latest release. To pin an exact one instead, add `@<version>` right after the package name — see [npmjs.com/package/@michaelyagi/shoji?activeTab=code](https://www.npmjs.com/package/@michaelyagi/shoji?activeTab=code) for what that currently is:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@michaelyagi/shoji@0.1.0-beta.11/dist/shoji.min.js"></script>
+```
+
 ## Quickstart
 
 ```html
@@ -78,6 +97,18 @@ npm run verify     # the full gate: typecheck + lint + unit + e2e + size
 
 `demo/assets/` (sample photos/video for the local demo pages) is gitignored — drop your own media there, or the demo pages just render with 0 items.
 
+## Releasing
+
+1. Bump `package.json`'s `version` to `<version>`, commit, and push to `main`.
+2. Tag that same version and push the tag:
+
+```bash
+git tag v<version>   # "v" + package.json's version, e.g. v0.1.0-beta.11
+git push --tags
+```
+
+Pushing the tag triggers `.github/workflows/ci.yml`'s `publish-npm` job — it runs the full verify gate (typecheck, lint, unit, e2e, size) first and only publishes if that passes. The dist-tag is derived automatically from the version string: a prerelease (e.g. `0.1.0-beta.11`) publishes under its own tag (`beta`) and is also promoted to `latest`; a plain version (e.g. `1.0.0`) just publishes as `latest` directly.
+
 ## License
 
 MIT © Michael Yagi