Skip to content

Expand README with comprehensive documentation#3

Merged
conallob merged 2 commits into
mainfrom
claude/readme
May 5, 2026
Merged

Expand README with comprehensive documentation#3
conallob merged 2 commits into
mainfrom
claude/readme

Conversation

@conallob
Copy link
Copy Markdown
Owner

@conallob conallob commented May 5, 2026

Summary

This PR significantly expands the README with complete user-facing documentation for the coding-interview-pattern-drill tool. The original minimal README has been replaced with a comprehensive guide covering installation, authentication, usage modes, and supported patterns.

Key changes

  • Project description: Clarified the purpose and value proposition — targeting the pattern recognition gap in interview prep rather than general LeetCode criticism
  • Installation instructions: Added three installation methods (Homebrew, go install, and build from source)
  • Authentication guide: Documented how to obtain and supply LeetCode session credentials for both CLI and server modes
  • CLI mode documentation:
    • Complete flag reference with defaults and descriptions
    • Practical usage examples
    • Sample quiz flow output showing the user experience
  • HTTP server mode documentation:
    • Setup and launch instructions
    • Browser-based credential management workflow
    • Quiz configuration options
  • Pattern reference table: Listed all 18 supported algorithmic patterns with their CLI slugs
  • Caching documentation: Explained cache locations, TTL, and refresh mechanisms

Notable details

  • The documentation emphasizes the tool's unique value: hand-tuned confusion maps for wrong answers rather than random distractors
  • Both CLI and server modes are documented as first-class interfaces with equal detail
  • Examples are concrete and actionable (e.g., specific flag combinations, expected output)
  • The pattern table provides the exact slugs needed for --tag filtering, reducing user friction

https://claude.ai/code/session_01CSqri29pumwCCTp4ApU2da

claude added 2 commits May 5, 2026 20:48
Covers Homebrew/go install/source install, LEETCODE_SESSION cookie
extraction steps, all CLI flags with examples, the full quiz flow,
HTTP server setup and first-run browser flow, all 18 pattern slugs,
caching behaviour, and release/tagging instructions.

https://claude.ai/code/session_01CSqri29pumwCCTp4ApU2da
Adds a Why this exists section explaining the motivation — the pattern
recognition gap being the real bottleneck in interview prep, not the
coding itself. Removes the Releasing section, which is dev-facing and
has no place in a user README.

https://claude.ai/code/session_01CSqri29pumwCCTp4ApU2da
@conallob conallob merged commit 8303135 into main May 5, 2026
@conallob conallob deleted the claude/readme branch May 5, 2026 21:23
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.

2 participants