@lucaismyname/ginger 0.0.48 → 0.0.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +12 -10
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -2,6 +2,12 @@
2
2
 
3
3
  All notable changes to `@lucaismyname/ginger` are documented here.
4
4
 
5
+ ## 0.0.48
6
+
7
+ - **Documentation:** Refreshed the root monorepo [`README.md`](https://github.com/lucaismyname/ginger/blob/main/README.md), this package [`README.md`](https://github.com/lucaismyname/ginger/blob/main/packages/ginger/README.md), and [`docs/README.md`](https://github.com/lucaismyname/ginger/blob/main/packages/ginger/docs/README.md) (tooling, apps, publishing, docs map).
8
+ - **Publishing:** From the monorepo, use `npm run publish:lib` (runs `npm publish` inside `packages/ginger`) so the [npmjs.com package page](https://www.npmjs.com/package/@lucaismyname/ginger) shows **this** `README.md`. Publishing with `npm publish -w @lucaismyname/ginger` from the repo root can attach the **root** readme to registry metadata instead.
9
+ - **Repository (not shipped in the npm tarball):** [`CHANGELOG.md`](https://github.com/lucaismyname/ginger/blob/main/packages/ginger/CHANGELOG.md) is included in the published package; the landing app uses bundled audio samples, Prism-based Quick Start highlighting, and refactored components; the demo app aligns on orange accents and includes Playwright smoke tests; Husky + lint-staged and shared Biome formatting apply across workspaces.
10
+
5
11
  ## 0.0.45
6
12
 
7
13
  - Add crossfade module (`@lucaismyname/ginger/crossfade`)
package/README.md CHANGED
@@ -10,6 +10,10 @@ A headless react audio primitive for music and podcast UIs on the native **`<aud
10
10
  npm install @lucaismyname/ginger
11
11
  ```
12
12
 
13
+ ## Changelog
14
+
15
+ Release notes live in [`CHANGELOG.md`](https://github.com/lucaismyname/ginger/blob/main/packages/ginger/CHANGELOG.md) (also **published on npm** next to this readme).
16
+
13
17
  ## Quick Start
14
18
 
15
19
  ```tsx
@@ -51,6 +55,7 @@ Mount **`<Ginger.Player />`** once inside the same provider tree so the hidden a
51
55
 
52
56
  For docs beyond this README, use the repository links below:
53
57
 
58
+ - **Changelog**: [`CHANGELOG.md`](https://github.com/lucaismyname/ginger/blob/main/packages/ginger/CHANGELOG.md)
54
59
  - **Docs folder map** (Markdown vs generated API): [`docs/README.md`](https://github.com/lucaismyname/ginger/blob/main/packages/ginger/docs/README.md)
55
60
  - Getting started: [`docs/getting-started.md`](https://github.com/lucaismyname/ginger/blob/main/packages/ginger/docs/getting-started.md)
56
61
  - Testing guide: [`docs/guides/testing.md`](https://github.com/lucaismyname/ginger/blob/main/packages/ginger/docs/guides/testing.md)
@@ -1252,8 +1257,9 @@ These priorities guide new work in the library; they are not a guarantee of ship
1252
1257
 
1253
1258
  | Path | Purpose |
1254
1259
  |------|---------|
1255
- | [`packages/ginger`](packages/ginger) | Publishable library (`@lucaismyname/ginger`) |
1256
- | [`apps/demo`](apps/demo) | Demo app with working examples |
1260
+ | [`packages/ginger`](https://github.com/lucaismyname/ginger/tree/main/packages/ginger) | Publishable library (`@lucaismyname/ginger`) |
1261
+ | [`apps/demo`](https://github.com/lucaismyname/ginger/tree/main/apps/demo) | Demo app (feature matrix, Playwright smoke tests) |
1262
+ | [`apps/ginger-landing`](https://github.com/lucaismyname/ginger/tree/main/apps/ginger-landing) | Landing page (live player, bundled samples) |
1257
1263
 
1258
1264
  ```bash
1259
1265
  npm install --include=dev
@@ -1265,18 +1271,14 @@ If your npm config sets `omit=dev`, devDependencies may not install. Use `--incl
1265
1271
 
1266
1272
  ## Publish
1267
1273
 
1268
- Do **not** run `npm publish` at the repo root. The root package is **`private: true`**.
1274
+ Do **not** run `npm publish` at the **monorepo root** as if it were the package—the root `package.json` is **`private: true`**.
1269
1275
 
1270
- Publish from the workspace:
1276
+ From the **repository root**, use the helper script (it `cd`s into this folder so npm’s registry metadata picks up **this** `README.md` on [npmjs.com](https://www.npmjs.com/package/@lucaismyname/ginger)):
1271
1277
 
1272
1278
  ```bash
1273
1279
  npm run publish:lib
1274
1280
  ```
1275
1281
 
1276
- Or from `packages/ginger`:
1277
-
1278
- ```bash
1279
- npm publish --access public
1280
- ```
1282
+ Avoid `npm publish -w @lucaismyname/ginger` from the root for releases: the tarball contents are correct, but the **package page readme** can incorrectly show the **root** readme. Alternatively run `npm publish --access public` **from `packages/ginger`** after `npm run verify:release`.
1281
1283
 
1282
- `prepublishOnly` runs the library build automatically.
1284
+ `prepublishOnly` runs the library build and checks automatically.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lucaismyname/ginger",
3
- "version": "0.0.48",
3
+ "version": "0.0.49",
4
4
  "description": "A headless React audio-player primitive",
5
5
  "type": "module",
6
6
  "sideEffects": false,