Skip to content

docs: add comprehensive README.md#42

Merged
rianjs merged 1 commit intomainfrom
docs/41-readme
Feb 2, 2026
Merged

docs: add comprehensive README.md#42
rianjs merged 1 commit intomainfrom
docs/41-readme

Conversation

@rianjs
Copy link
Contributor

@rianjs rianjs commented Feb 2, 2026

Summary

Creates README.md from scratch documenting all 29 command packages (570 lines).

Structure follows google-readonly/README.md template:

  • Features - High-level overview
  • Installation - Homebrew, Chocolatey, Winget, binary download
  • Setup - HubSpot private app creation and token configuration
  • Commands - All categories with tables and examples:
    • Configuration (init, config)
    • CRM Objects (contacts, companies, deals, tickets, owners, products, line-items, quotes)
    • Engagements (notes, calls, emails, meetings, tasks)
    • Associations, Properties, Pipelines, Schemas
    • Marketing (forms, campaigns, marketing-emails)
    • CMS (files, domains, pages, blogs, hubdb)
    • Conversations
    • Workflows
    • GraphQL
  • Global Flags - Output format, colors, verbose mode
  • Common Patterns - Pagination, custom properties, --force
  • Shell Completion - Bash, Zsh, Fish, PowerShell
  • Configuration - File location, environment variables
  • Troubleshooting - Common errors and solutions

Test plan

  • Markdown renders correctly (checked locally)
  • All 29 command packages documented
  • Examples match current CLI behavior

Closes #41

🤖 Generated with Claude Code

Document all 29 command packages including:
- Installation instructions (Homebrew, Chocolatey, Winget)
- Authentication setup with HubSpot private apps
- CRM objects (contacts, companies, deals, tickets, etc.)
- Engagements (notes, calls, emails, meetings, tasks)
- Associations, properties, pipelines, schemas
- Marketing (forms, campaigns, marketing-emails)
- CMS (files, domains, pages, blogs, hubdb)
- Conversations
- Workflows
- GraphQL queries and schema exploration
- Global flags and common patterns
- Shell completion setup
- Configuration reference
- Troubleshooting guide

Closes #41
@rianjs rianjs merged commit 8acea26 into main Feb 2, 2026
3 checks passed
@rianjs rianjs deleted the docs/41-readme branch February 2, 2026 11:12
@rianjs rianjs mentioned this pull request Feb 2, 2026
2 tasks
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.

docs: Create comprehensive README.md

1 participant

Comments