Skip to content

Keep the README focused on getting started - #1060

Merged
mcncl merged 1 commit into
mainfrom
bm/simplify_readme
Oct 21, 2026
Merged

mcncl merged 1 commit into
mainfrom
bm/simplify_readme

Conversation

@mcncl

@mcncl mcncl commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

Description

Keep the README focused on getting started. Detailed usage belongs in the official CLI documentation rather than a second reference in the repository.

Changes

  • Reduce the README to installation, browser login, and the official documentation link.
  • Use the current Homebrew formula and link to installation options for other platforms.
  • Preserve certificate-trust guidance in CONTRIBUTING.md.

Testing

  • Markdown lint, Prettier, and git diff --check pass.
  • All six README URL targets return HTTP 200; GitHub's Markdown renderer produces the expected sections and commands.
  • Verified the certificate guidance was moved verbatim.
  • Go tests and Go formatting are not applicable to this documentation-only change.

Keep installation and browser login in the README, with links to the
installation guide and official documentation for everything else.

Move certificate-trust guidance to the contributor guide so it remains
available without overwhelming new users.
@mcncl
mcncl requested review from a team as code owners October 21, 2026 05:27
@mcncl
mcncl enabled auto-merge (squash) October 21, 2026 05:28
@mcncl
mcncl merged commit 171cfef into main Oct 21, 2026
2 checks passed
@mcncl
mcncl deleted the bm/simplify_readme branch October 21, 2026 05:29
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