Skip to content

docs: launch README - #19

Merged
KNIHAL merged 2 commits into
mainfrom
docs/readme
Nov 20, 2026
Merged

KNIHAL merged 2 commits into
mainfrom
docs/readme

Conversation

@KNIHAL

@KNIHAL KNIHAL commented Nov 20, 2026

Copy link
Copy Markdown
Owner

What

New README for launch, replacing the old command dump.

  • Tagline and hook, badges (CI, npm, licence, Node).
  • Why PCS and the verified / reported / inferred model.
  • Quick start: install, pcs init, pcs connect, agents install, hooks install, doctor.
  • A step-by-step handoff example and what resume does.
  • Features, command overview by area, MCP tools and flags, security model with honest limits, platform support, uninstall, contributing links.
  • No demo or screenshots yet (to be added later).

Why

The README is the npm page and the first thing visitors read; it is frozen into the package at publish time, so it lands before the first release.

Checks

Encoding test passes. Commands and flags were checked against pcs --help.

?? Generated with Claude Code

https://claude.ai/code/session_01KXDWKPCAN5EkLoUwsvtKh3

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KXDWKPCAN5EkLoUwsvtKh3
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-20T06:11:44.973800Z c0462cc PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c0462cc0dc

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +65 to +66
pcs note add task "Add the --json flag to the exporter"
pcs test --task <task-id> -- npm test # PCS runs it and records the result

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Create a task before linking test evidence

In this walkthrough, pcs note add task records an original-task note; it does not create a task or provide the ID that pcs test --task requires. As written, the next command cannot link its run to a task. Add a pcs task add step and use that ID, or omit --task.

Useful? React with 👍 / 👎.

Comment thread README.md

## Uninstall

`pcs deinit` removes everything PCS added to a project: the `.pcs` folder, hooks, instruction blocks and the login entry. `pcs connect <app> --remove` removes the MCP entry.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Document that deinit requires --yes

When readers follow this uninstall instruction, plain pcs deinit only displays a removal plan and leaves the project unchanged. The CLI requires pcs deinit --yes to perform the removal, so document that flag to avoid users thinking the uninstall is complete.

Useful? React with 👍 / 👎.

@KNIHAL
KNIHAL merged commit de966fd into main Nov 20, 2026
12 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