docs(readme): beginner-friendliness pass#1
Merged
Conversation
Restructured for someone who's never installed a CLI before: - Add Prerequisites section: Node.js version check + Zeffy account - Replace separate Install/Authenticate sections with a single numbered 'Quick start (5 minutes)' walkthrough covering install → API key → auth → first command → first EOY report, with expected output at each step - Mark the MCP section 'Optional' with a clear skip-this hint - Add Troubleshooting section for the 5 common failure modes: command-not-found, missing API key, 401 Invalid Key, 429 rate limit, PDF output location, logo validation rejection - Explain 'pt' in the logo-size flag (link to PDF points) - Add npm version badge - Mention DEBUG=1 for verbose error output - Note the automated tag-push release pipeline in Development section
There was a problem hiding this comment.
Pull request overview
Improves the project’s onboarding documentation by restructuring the README to help first-time users install the CLI, configure authentication, and generate an end-of-year report quickly, with added MCP framing and troubleshooting guidance.
Changes:
- Adds a prerequisites + “Quick start (5 minutes)” guided walkthrough (install → API key → first command → EOY report).
- Reorganizes CLI/MCP/SDK sections and adds troubleshooting for common setup and runtime errors.
- Adds npm version badge and expands development/release process notes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Six accuracy fixes from automated review on PR #1: - Drop fictional ✓ checkmark from `zfy auth status` example output (the CLI prints `Authenticated.` in green, no glyph) - Note that the config path can be under XDG_CONFIG_HOME and point readers to `zfy auth path` for the exact location - Replace `npm root -g` (returns node_modules) with `npm prefix -g` (returns the install prefix whose `bin` is on PATH) - Acknowledge both error prefixes for 401 (`API error` from auth status, `Zeffy API error` from other commands) - Show the full logo-validation warning string verbatim and clarify that other variants behave the same way - Drop the hardcoded "21 tests" annotation that would rot as the suite grows
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.
Summary
Restructures the README so a first-time user (e.g. a nonprofit volunteer who's never installed a CLI) can get to their first EOY report in 5 minutes.
Changes
command not found: zfyNo Zeffy API key configured401 Invalid API key429 Too Many Requestsskipping logo — image is not squareptin--logo-size(link to PDF points)DEBUG=1for verbose error outputTest plan
zfy ...commands shown match the actual flag set in `src/cli/`