Skip to content

docs: add comprehensive README and npm package config#6

Merged
piotrski merged 1 commit into
mainfrom
docs/readme-and-package-config
Feb 10, 2026
Merged

docs: add comprehensive README and npm package config#6
piotrski merged 1 commit into
mainfrom
docs/readme-and-package-config

Conversation

@piotrski
Copy link
Copy Markdown
Collaborator

@piotrski piotrski commented Feb 10, 2026

Summary

  • Add full README with installation, quick start, all CLI commands, app connection guide (including Vite workaround), AI agent usage instructions, and architecture diagram
  • Configure package.json with files array and prepublishOnly script to copy root README into package directory at publish time
  • Add packages/agent-react-devtools/README.md to .gitignore (generated at publish time)

Test plan

  • Verify README renders correctly on GitHub
  • Verify npm pack includes README in the tarball

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Feb 10, 2026

🦋 Changeset detected

Latest commit: aa8f93d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
agent-react-devtools Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@piotrski piotrski force-pushed the docs/readme-and-package-config branch 14 times, most recently from d736020 to e7271cf Compare February 10, 2026 00:46
@piotrski piotrski force-pushed the docs/readme-and-package-config branch from e7271cf to aa8f93d Compare February 10, 2026 00:48
@piotrski piotrski merged commit 10ac53c into main Feb 10, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant