docs: add Quick Start guide

[okwn]

Summary

Adds a Quick Start section to the README with basic installation and usage instructions.

Changes

• Added Quick Start section with installation commands
• Added clone and run instructions

Testing

• Documentation builds correctly
• Links are valid

Checklist

• Code follows project style guidelines
• Documentation updated

---

Summary by cubic

Adds a Quick Start section to README.md with simple install and run steps. Includes pip install agentmail-python and a git clone + python setup.py install path.

^{Written for commit 4fedcb1. Summary will update on new commits. Review in cubic}

[cubic-dev-ai]

2 issues found across 1 file

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="README.md">

<violation number="1" location="README.md:8">
P1: Quick Start uses incorrect package name `agentmail-python` instead of the documented `agentmail`</violation>

<violation number="2" location="README.md:15">
P2: Quick Start documentation references `python setup.py install` but the repository has no `setup.py` file (only `pyproject.toml` with Poetry). This command will fail for users following the instructions.</violation>
</file>

<sub>Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic</sub>

[cubic-dev-ai]

P1: Quick Start uses incorrect package name agentmail-python instead of the documented agentmail

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 8:

<comment>Quick Start uses incorrect package name `agentmail-python` instead of the documented `agentmail`</comment>

<file context>
@@ -1,5 +1,21 @@
+
+Install with:
+```bash
+pip install agentmail-python
+```
+
</file context>

Suggested change

	pip install agentmail-python
	pip install agentmail

[cubic-dev-ai]

P2: Quick Start documentation references python setup.py install but the repository has no setup.py file (only pyproject.toml with Poetry). This command will fail for users following the instructions.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 15:

<comment>Quick Start documentation references `python setup.py install` but the repository has no `setup.py` file (only `pyproject.toml` with Poetry). This command will fail for users following the instructions.</comment>

<file context>
@@ -1,5 +1,21 @@
+```bash
+git clone https://github.com/agentmail-to/agentmail-python.git
+cd agentmail-python
+python setup.py install
+```
+
</file context>