Skip to content

docs: add comprehensive README - #21

Merged
jmgilman merged 1 commit into
masterfrom
docs/readme
Jan 24, 2026
Merged

jmgilman merged 1 commit into
masterfrom
docs/readme

Conversation

@jmgilman

Copy link
Copy Markdown
Contributor

Summary

  • Add professional README documentation for the blob CLI
  • Include installation methods (script, Homebrew, Scoop, go install, manual download)
  • Document all commands with quick start examples
  • Add configuration section with example config file
  • Document signing/verification workflows and policy format
  • Include environment variables, global flags, and exit codes reference

Test plan

  • Verify badge links work correctly
  • Confirm installation instructions are accurate
  • Review command examples for correctness

🤖 Generated with Claude Code

Add professional README documentation including:
- Installation methods (script, Homebrew, Scoop, go install, manual)
- Quick start examples and command reference
- Configuration documentation with example config file
- Signing and verification usage examples
- Environment variables, global flags, and exit codes

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@jmgilman
jmgilman merged commit 2cb1b25 into master Jan 24, 2026
7 checks passed
@jmgilman
jmgilman deleted the docs/readme branch January 24, 2026 01:39
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