Skip to content

Add README to npm registry package #1015

@ElioNeto

Description

@ElioNeto

Problem

The @teamcode-ai/teamcode package published to npm does not include a README.md file. This means the npm registry page shows no documentation, usage instructions, or project description.

Impact

  • Users browsing npmjs.com see an empty package page
  • No quick-start instructions visible on the registry
  • Reduced discoverability and trust

Solution

Update packages/teamcode/script/publish.ts to copy the repository README.md into the meta-package dist directory before publishing:

// In the meta-package creation section, add:
await $`cp ../../README.md ./dist/${pkg.name}/README.md`

This ensures the README is bundled with the published package and displayed on npmjs.com.

Files to modify

  • packages/teamcode/script/publish.ts — copy README.md into dist/teamcode/ before the npm publish step

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions