Trim README to the essentials#115
Merged
Merged
Conversation
Greptile SummaryThis PR condenses
Confidence Score: 5/5Documentation-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
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]
Reviews (2): Last reviewed commit: "Clarify source install alternatives" | Re-trigger Greptile |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
--helpand the generated docs.Why
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.mdfrom a long command catalog into a short onboarding doc: install/auth, a few representative workflows, and pointers togumroad --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 installlayout 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.