Context
AutobahnJS 26.3.1 was just published with strict-mode fixes for Vite 8 / Rolldown. A full-stack demo (Vue 3.6 + Pinia 3 + Vite 8 + Crossbar.io) with Vitest and Playwright tests now exists. The README should reflect this modernized state.
Problem
The npm package page currently shows:
"This package does not have a README. Add a README to your package so that users know how to get started."
This is because packages/autobahn/package.json has a files field that only includes index.js and /lib, and there is no README.md inside packages/autobahn/. npm publishes from that directory, so the repo root README.md never makes it into the tarball.
Root cause
"files": [
"index.js",
"/lib"
]
No README.md in packages/autobahn/, and README.md is not listed in files.
Fix
Option A (simplest): Add "README.md" to the files array and either symlink or copy the repo root README into packages/autobahn/.
Option B (better): Create a dedicated packages/autobahn/README.md tailored for npm consumers (install, quick start, link to full docs), since the repo root README contains developer/contributor info that isn't relevant to npm users.
I'd recommend Option B — the npm README should be focused and concise:
- One-liner: what it is (WAMP for browsers and Node.js)
- Install:
npm install autobahn
- Quick start example (connect, subscribe, call — 20 lines)
- Key features (RPC, PubSub, cryptosign auth, browser + Node.js)
- Compatibility: Node.js 22+, modern browsers, Vite 8 / Rolldown
- Links: full docs, GitHub repo, Crossbar.io, WAMP spec
- License
Additional README improvements
The repo root & npm README should contain direct links to the release version on both:
- the Git tagged version on GitHub, e.g. v26.3.1
- the corresponding npm published version, e.g. v26.3.1
The repo root README.md could also use updates:
Context
AutobahnJS 26.3.1 was just published with strict-mode fixes for Vite 8 / Rolldown. A full-stack demo (Vue 3.6 + Pinia 3 + Vite 8 + Crossbar.io) with Vitest and Playwright tests now exists. The README should reflect this modernized state.
Problem
The npm package page currently shows:
This is because
packages/autobahn/package.jsonhas afilesfield that only includesindex.jsand/lib, and there is noREADME.mdinsidepackages/autobahn/. npm publishes from that directory, so the repo rootREADME.mdnever makes it into the tarball.Root cause
No
README.mdinpackages/autobahn/, andREADME.mdis not listed infiles.Fix
Option A (simplest): Add
"README.md"to thefilesarray and either symlink or copy the repo root README intopackages/autobahn/.Option B (better): Create a dedicated
packages/autobahn/README.mdtailored for npm consumers (install, quick start, link to full docs), since the repo root README contains developer/contributor info that isn't relevant to npm users.I'd recommend Option B — the npm README should be focused and concise:
npm install autobahnAdditional README improvements
The repo root & npm README should contain direct links to the release version on both:
The repo root
README.mdcould also use updates:global: 'globalThis',use_es6_promises: true)import autobahn from 'autobahn') alongside the existing CommonJS example