[yakupyigit]

Completes Phase 5 (Documentation and final review) by comprehensively documenting the tool for end users and contributors.

Summary

Rewrites the root README from scratch to serve as the primary user guide, adds CONTRIBUTING.md for developers, and improves CLI help text. All documentation is now aligned with the implemented feature set.

Key changes

README.md (complete rewrite):

• Quick start section with three-command example
• Comprehensive command reference with flag table (all 15 flags documented)
• Exit codes table (0, 1, 2, 3, 130)
• Configuration reference: top-level fields, github source, target types with provider-specific settings (AWS S3, Cloudflare R2, Backblaze B2, MinIO)
• Snapshot layout and manifest structure
• Scheduling examples: cron and launchd (macOS)
• Restoration procedures: cloning bundles, unpacking LFS tars, pushing to new remotes
• Limitations section (what is and isn't backed up)
• Development setup and testing instructions

CONTRIBUTING.md (new file):

• Setup and check commands
• Ground rules for code organization, external programs, git config, secrets, testing, and language
• Step-by-step guides for adding a new source and a new target
• Commit and PR conventions

src/program.ts:

• Enhanced --help descriptions with defaults and constraints (e.g., "default 4", "1-64", "a target's own keep wins")
• Clarified --local description: names the temporary target "local"

test/unit/commands.test.ts:

• New test verifying all 15 flags documented in README appear in backup --help output

plans/ (status updates):

• Phase 5 marked complete with detailed notes on what was verified (config schema, env variables, flag alignment, restoration steps)
• Architecture document updated with directory structure including new docs

Notable details

• Configuration examples in README match config.example.json and pass the schema
• Environment variables (GHBACKUP_*) listed in README match those in src/config/load.ts
• Restoration instructions tested against actual LFS and local target integration tests
• All 15 CLI flags cross-referenced between README table, --help output, and new test

https://claude.ai/code/session_01VfKrT9Df5CR6n4ZEVb8rmH