Files
airship/apps
Nayan 9461e3a6f6 build(cli): ship a README with the published package
@airshiplabs/cli's npm page reads "This package does not have a
README" while a 400-line one sits at the repo root. npm renders the
README from the PACKAGE directory, and apps/cli has never had one —
pnpm copies the root LICENSE into a workspace package that lacks one,
but it does not do the same for README.

Copying it verbatim is not enough: npm resolves relative links against
repository.directory (apps/cli), where media/cover.png does not exist,
so all seven screenshots would 404. scripts/sync-readme.mjs rewrites
them to absolute GitHub URLs — raw.githubusercontent for images, since
the blob view serves HTML, and blob for everything else.

The output is committed rather than built on demand, like
apps/web/src/routeTree.gen.ts, so a clean checkout can publish without
running the generator. Two guards keep it honest: checks.yml fails a PR
when it is stale, and verify-tarball.sh now asserts README.md is in the
tarball, so a README-less publish cannot happen twice.
2026-08-11 06:01:31 +05:30
..