Skip to content

Trim README to the essentials#115

Merged
gianfrancopiana merged 3 commits into
mainfrom
gianfranco/prune-readme-verbosity
May 25, 2026
Merged

Trim README to the essentials#115
gianfrancopiana merged 3 commits into
mainfrom
gianfranco/prune-readme-verbosity

Conversation

@gianfrancopiana
Copy link
Copy Markdown
Member

@gianfrancopiana gianfrancopiana commented May 25, 2026

What

  • Reduced the README to a compact entry point instead of a command catalog.
  • Kept the install, auth, and a few representative workflows, while deferring full command syntax to --help and the generated docs.
  • Preserved the admin-token note because it is cross-cutting behavior, not command reference material.

Why

  • The README had grown into a mirror of the CLI tree, which made it harder to scan and easier to let drift.
  • The shorter version is easier to maintain and better matches the role of a top-level README: orient, not document everything.

This PR was implemented with AI assistance using gpt‑5.5 xhigh.


Note

Low Risk
Documentation-only README edits with no runtime or API behavior changes.

Overview
Trims README.md from a long command catalog into a short onboarding doc: install/auth, a few representative workflows, and pointers to gumroad --help / generated docs for full syntax.

Removes the full CLI tree listing, long admin example blocks, and deep coverage of sales CSV/export, file recovery/abort, variant media, and output-mode edge cases—while keeping cross-cutting notes (admin token env vars, agent skill, development targets).

Tightens install/auth copy (drops brew cask migration, make install layout detail, and some OAuth/admin-token prose) and consolidates alternate install methods into a single collapsible block.

Reviewed by Cursor Bugbot for commit 24f0da2. Bugbot is set up for automated code reviews on this repo. Configure here.

@gianfrancopiana gianfrancopiana self-assigned this May 25, 2026
@gianfrancopiana gianfrancopiana marked this pull request as ready for review May 25, 2026 19:38
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 25, 2026

Greptile Summary

This PR condenses README.md from a detailed command catalog into a lean onboarding document, deferring full syntax to gumroad --help and the generated docs.

  • Removed: CLI command tree, long admin example blocks, sales CSV export commands, file recovery/abort flows, and covers/thumbnail subcommands — all still accessible via --help.
  • Simplified: Install section consolidates alternatives into a single code block; auth and file-attachment prose is shortened while keeping key env vars (GUMROAD_ACCESS_TOKEN, GUMROAD_ADMIN_TOKEN, GUMROAD_ADMIN_API_BASE_URL).
  • Renamed: "Claude Code skill" reference updated to the more generic "agent skill", consistent with the non-Claude-specific SKILL.md frontmatter.

Confidence Score: 5/5

Documentation-only change with no runtime impact; safe to merge.

Only README.md is touched. All retained content was verified against the repo's CLI structure and SKILL.md. No code, config, or build files are affected.

No files require special attention.

Important Files Changed

Filename Overview
README.md Documentation-only trimming; all retained content is accurate and cross-checked against CLI behaviour described elsewhere in the repo.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[New user lands on README] --> B{Install method}
    B -->|Homebrew| C[brew install antiwork/cli/gumroad]
    B -->|Other| D[Shell script / Go / make install]
    C --> E[Quick start]
    D --> E
    E --> F{Auth method}
    F -->|Interactive| G[gumroad auth login]
    F -->|CI / agents| H[GUMROAD_ACCESS_TOKEN env var]
    G --> I[Use CLI commands]
    H --> I
    I --> J{Need full syntax?}
    J -->|Yes| K[gumroad --help / gumroad command --help]
    J -->|No| L[Use examples from README]
Loading

Reviews (2): Last reviewed commit: "Clarify source install alternatives" | Re-trigger Greptile

Comment thread README.md Outdated
@gianfrancopiana gianfrancopiana merged commit 097beb6 into main May 25, 2026
6 checks passed
@gianfrancopiana gianfrancopiana deleted the gianfranco/prune-readme-verbosity branch May 25, 2026 19:47
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