Skip to content

README: the whole toolkit at the root, and the player's own README for npm - #235

Merged
alekswebnet merged 4 commits into
mainfrom
chore/readme-title
Nov 18, 2026
Merged

alekswebnet merged 4 commits into
mainfrom
chore/readme-title

Conversation

@alekswebnet

@alekswebnet alekswebnet commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Closes #234.

The repository is now h5p-toolkit, but its README still put the player at the centre. This PR makes the root README the toolkit's front page. The player gets a README of its own, which is what npm shows.

What changes

  • The root README covers the whole toolkit:
    • the opening line, chosen by the owner: "Everything you needed an H5P server for (playing, building, checking, packaging for an LMS) as static files, command-line tools and agent skills";
    • the demo links, now with the build page;
    • a status line: the player and the packages around it at 1.x since October 2026; the author package, the MCP server and the VS Code extension at 0.x;
    • What it does: a table by task (play, embed or hand to an LMS, build with AI, check, make video stream, offline or in VS Code), each with its tool;
    • Why this one:
      • no H5P server anywhere;
      • the packages people have play;
      • what a model builds is checked;
      • nothing passes through a server of ours;
      • and what it is not: no editor, no results store;
    • Quick start in three: play, build with AI, check;
    • then the packages, the skills, the docs and contributing;
    • a licence section for every package: MIT, except the runtime (GPL-3.0) and the library pack (each library under its own licence).
  • packages/player/README.md, now tracked, is the player's page as npm showed it, titled @missing-elements/h5p-offline-player.
    • Its tools line points to the toolkit.
    • The package table, the skills and contributing stay at the root.
  • prepack copies only LICENSE now, so this PR's earlier title swap goes. .gitignore stops ignoring the player's README.
  • cubic's findings, fixed:
    • Firefox and WebKit run every week and before each release, not on every change. The player's README and docs/compatibility.md still said otherwise after PRs moved to Chromium only.
    • cmi5 and the SCORM zip are credited to h5p-cmi5 and h5p-embed.
    • The root quick start says again that a package exported without its libraries, as h5p.com exports, needs libraries="pack".
  • design/build.md and design/licensing.md describe the new arrangement.

Tested

  • node packages/player/scripts/prepack.mjs copies LICENSE and leaves the tracked README alone. npm pack --dry-run lists the player's own README.md and LICENSE.
  • The player's pnpm typecheck passes.
  • Every github.com/missing-elements/h5p-toolkit/blob|tree/main/… link in both READMEs points at a file or folder that exists.
  • The root README's claims were checked against the source:
    • the 28 types the h5p-author skill offers (its SKILL.md);
    • npx skills add … --skill;
    • npx @missing-elements/h5p-verify@latest and Node 22 or later (the packages' engines);
    • each package's licence (its package.json);
    • the names on the comparison page;
    • the browser policy (design/testing.md).

Not verified

  • The install commands were not re-run from a clean machine. They are the ones the last README audit ran, unchanged.

Summary by cubic

The root README now presents the whole toolkit, and @missing-elements/h5p-offline-player keeps its own README for npm instead of a copied root one with a replaced title.

  • packages/player/README.md is the player's page on npm, titled with the package's name and holding the player-focused content the root README used to carry.
  • The root README.md is rewritten as the toolkit's front page, covering the player, AI authoring, verification, and the surrounding packages.
  • prepack.mjs now copies only the LICENSE; design/build.md and design/licensing.md describe the new setup.
  • docs/compatibility.md states the browser suite runs in Chromium on every change and in Firefox and WebKit weekly and before each player release.
  • Takes effect with the player's next release.

Written for commit 600fed7. Summary will update on new commits.

View guided diff Turn on auto-fix

@alekswebnet alekswebnet added the documentation Improvements or additions to documentation label Nov 18, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 3 files

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread packages/player/scripts/prepack.mjs Resolved
@alekswebnet alekswebnet changed the title The player's npm README keeps its package name as its title README: the whole toolkit at the root, and the player's own README for npm Nov 18, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 6 files (changes from recent commits).

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread packages/player/README.md Resolved
Comment thread README.md Resolved
Comment thread packages/player/README.md Resolved
…RM come from their packages; the quick start names libraries="pack" (#234)
@alekswebnet
alekswebnet merged commit cc49e94 into main Nov 18, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Title the README for the toolkit, and the player's npm copy with the package name

1 participant