From 8a59cb879672993ed36a9cfe4be46b187f939dff Mon Sep 17 00:00:00 2001 From: Alessandro <155005371+3clyp50@users.noreply.github.com> Date: Tue, 28 Apr 2026 14:05:33 +0200 Subject: [PATCH] update main readme pre v1.10 Update README.md replace thumb img and update main readme --- README.md | 345 +++++++++++------- .../a0-vector-graphics/horizontal_banner.svg | 60 +++ docs/res/showcase-thumb.png | Bin 21896 -> 0 bytes docs/res/thumbnail-install.webp | Bin 0 -> 15780 bytes docs/res/time-travel.png | Bin 0 -> 72770 bytes 5 files changed, 265 insertions(+), 140 deletions(-) create mode 100644 docs/res/a0-vector-graphics/horizontal_banner.svg delete mode 100644 docs/res/showcase-thumb.png create mode 100644 docs/res/thumbnail-install.webp create mode 100644 docs/res/time-travel.png diff --git a/README.md b/README.md index f75aa3ac8..de98e1f10 100644 --- a/README.md +++ b/README.md @@ -1,185 +1,250 @@
+
+It is not a replacement for Git or backups. It is a practical safety layer for the workspace where agents are actively creating and editing files.
+
+## Real-World Use Cases
+
+- **Software engineering:** inspect a codebase, make scoped edits, run tests, explain tradeoffs, and keep a recoverable history of file changes.
+- **Host-machine development:** connect with `a0`, grant Read+Write and remote execution when needed, and let Agent Zero work in your real local repositories.
+- **Financial analysis and charting:** collect data, correlate events, create spreadsheets, and generate editable charts.
+- **Office deliverables:** cowork on documents, spreadsheets, and presentation decks instead of trapping the result in chat text.
+- **Web and mobile QA:** browse an app, annotate UI issues, install browser extensions, and turn visual comments into actionable fixes.
+- **API integration:** paste an API snippet, let the agent build a working example, and store the pattern for future use.
+- **Client/project isolation:** keep memory, secrets, instructions, files, and model choices separated by project.
+- **Scheduled operations:** run recurring checks and monitoring tasks with project-scoped context and credentials.
+
+## Safety Model
+
+Agent Zero is powerful because it can use a real environment. Treat it with the same respect you would give a capable developer with shell access.
+
+- Keep it running inside Docker or another isolated environment.
+- Do not mount your entire home directory unless you understand the risk.
+- Grant A0 CLI Read+Write access and remote code execution only for machines and workspaces you trust.
+- Store credentials in project secrets or settings, not in prompts or public files.
+- Review actions that touch accounts, money, production systems, or private data.
+- Keep backups for important workspaces.
+- Install browser extensions and third-party plugins only from sources you trust.
+
+## Documentation
+
+| I want to... | Start here |
+| --- | --- |
+| Install or update Agent Zero | [Installation](./docs/setup/installation.md) |
+| Learn the UI and basic workflow | [Quickstart](./docs/quickstart.md) |
+| Connect Agent Zero to host-machine files and shell | [A0 CLI Connector](./docs/guides/a0-cli-connector.md) |
+| Use projects and Git workspaces | [Projects guide](./docs/guides/projects.md) |
+| Create or switch Agent Profiles | [Agent Profiles](./docs/guides/agent-profiles.md) |
+| Use skills and agent capabilities | [Usage guide](./docs/guides/usage.md) |
+| Configure MCP or external tools | [MCP setup](./docs/guides/mcp-setup.md) |
+| Understand the architecture | [Architecture](./docs/developer/architecture.md) |
+| Build extensions or plugins | [Extensions](./docs/developer/extensions.md) |
+| Contribute to the project | [Contributing](./docs/guides/contribution.md) |
+| Troubleshoot problems | [Troubleshooting](./docs/guides/troubleshooting.md) |
+
+## Build With Us
+
+Agent Zero is built for people who want to understand and shape their tools.
+
+You can help by improving docs, creating skills, publishing plugins, testing model/provider setups, reporting bugs, sharing workflows, or contributing core improvements. Start with the [Contributing guide](./docs/guides/contribution.md), browse the [Plugin Hub](./docs/guides/usage.md), or bring ideas to Discord.
+
+## Community and Support
+
+- [Discord](https://discord.gg/B8KZKNsPpj) for live discussion and help.
+- [Skool Community](https://www.skool.com/agent-zero) for community learning.
+- [YouTube](https://www.youtube.com/@AgentZeroFW) for demos and tutorials.
+- [X](https://x.com/Agent0ai), [LinkedIn](https://www.linkedin.com/company/109758317), and [Warpcast](https://warpcast.com/agent-zero) for updates.
+- [GitHub Issues](https://github.com/agent0ai/agent-zero/issues) for bugs and feature requests.
diff --git a/docs/res/a0-vector-graphics/horizontal_banner.svg b/docs/res/a0-vector-graphics/horizontal_banner.svg
new file mode 100644
index 000000000..ddf5a215f
--- /dev/null
+++ b/docs/res/a0-vector-graphics/horizontal_banner.svg
@@ -0,0 +1,60 @@
+
\ No newline at end of file
diff --git a/docs/res/showcase-thumb.png b/docs/res/showcase-thumb.png
deleted file mode 100644
index c2cb31020cc4dca06709d3d430d9611cc6da5ee8..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 21896
zcmeFYg7$Ngm18{Dof i#|kKew468oxgRa-g>vN}@hZStx$Y-h0xt2U4i@7~WY5!LYf@j$@_5)q{4^i^H4
zpHEc_y13FOjS>C*sgz1|t*wJ_W5*z#|4{k!H~WWr$zC){_)N->h)ED^y=YDVGdoTMqE8`-r>Cj<5jh9MpQ1
?LP
7Z&KHZ7-(dEfoju%H>ZFxHz>&Eva|CE`|%FfD>
zdMVKaT
D!F0CF{h+1$W3ah^F@H4
1yAFE->kS
;P_;(5`g;puXSZsznzp;J9
zH$Lxbi$bDwqffeHOBgdG`bNP%BKpzUEjhzlM7eDHGP&H_NGUzX($9>pZ05)G8nOC=
zdaVtg`nFA=2V+=puL-pOkaOM6ipwq07$Y5xFVhJUWp`}1FOJO1K644ixuiB%8kAU+
z!>@~rxk?k3s%0F}mx70jF}Fv?&xS0~%$vq}+$TAhzf3Tju8(x3K|}LYfW55k`=i1{
z2WwXbu+kVFX}4F$MfBX}m%mrBTCHO_K|%%HhqZfufvG4#
zhW1?%n*u9;Hm2y9%E&G&x`qSeKC4dcpRP>DIV5>b+_m%VLv@~ojOZDR(4Lq4NOQ9+
zpl#)R_qwFi_Jyx|8};vd#VzZL$4S_aWcixXx%qFM!3pKQf>arMV_&pSwLQ7|6nrBy
zHth8+yjR#92|kt5`E~nou_C<7$>UgE6Pq;OkLQ~Uz<%1j{cX~0D?v$PtgtmyhKam0
z6J6```#|k4``DaNmwGm$A40mj=ntw&dOnkoP3BLjJLae`=>S