docs: Rewrite README with architecture diagram and examples

[facundofarias]

Summary

• Add architecture diagram showing how the agent proxies connections
• Document all available commands in a table
• Add configuration file reference with access list editing examples
• Add troubleshooting section for common issues
• Add development and release sections

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Rebranded and restructured documentation for Deploy Agent
  • Added architecture diagram and "How It Works" workflow visualization
  • Enhanced Quick Start guide with step-by-step setup and configuration instructions
  • Expanded command reference documentation for all agent operations
  • Improved troubleshooting section with solutions for common issues
  • Updated development and contribution guidelines

[coderabbitai]

Caution

Review failed

The head commit changed during the review from 0c9fc0b to 60a6f16.

Walkthrough

The README.md file has been completely rebranded from "Deploy Agent Client" to "Deploy Agent" with a restructured documentation layout. Changes include a new "How It Works" architectural diagram, reorganized Quick Start instructions, expanded Commands and Configuration sections with detailed ~/.deploy/ file documentation, reworked Troubleshooting guidance, and updated Development/Release sections incorporating Conventional Commits standards.

Changes

Cohort / File(s)	Summary
Documentation README.md	Complete restructure and rebranding with new diagrams, reorganized Quick Start workflow, expanded Commands and Configuration sections with ~/.deploy/ files documentation, enhanced Troubleshooting guidance, and updated Development/Release sections with Conventional Commits guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hops through the README with glee,
A clearer path for all to see,
Diagrams bright, the flow laid bare,
Deploy Agent—now with extra care! 🚀

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and accurately reflects the main changes in the pull request: rewriting the README with an architecture diagram and examples.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/improve-readme

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 7-12: The fenced code block containing the ASCII diagram lacks a
language identifier (triggering MD040); update the triple-backtick fence around
the diagram (the block that starts with ``` and contains the ASCII diagram lines
with "DeployHQ", "Deploy Agent", and "Your Server(s)") to include a language
token such as text (i.e., change ``` to ```text) so markdownlint passes.
- Around line 98-106: The fenced code block in README.md lacks a language
identifier (MD040); update the opening triple backticks for the access list
example to include a language such as `text` or `conf` (i.e., change ``` to
```text or ```conf) so the block is properly annotated and Markdownlint stops
flagging MD040.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6b2b85035e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[chatgpt-codex-connector]

Add HTTPS setup endpoint to firewall requirements

The requirements list implies that opening outbound port 7777 is sufficient, but initial setup also needs outbound HTTPS to api.deployhq.com:443 to request the client certificate (ConfigurationGenerator#certificate_uri in lib/deploy_agent/configuration_generator.rb). In environments that follow this README literally and only allow 7777, deploy-agent setup will fail before the agent can be provisioned.

Useful? React with 👍 / 👎.