Multiplayer agent harness for work.
Give the README a logo banner, badges, and section nav (#1672)
Joshua Francee8ceaf6dfd9f
diff --git a/README.md b/README.mdindex c678e1b50..ebf5c2920 100644--- a/README.md+++ b/README.md@@ -1,16 +1,22 @@-# qm+<p align="center">+ <img src="docs/images/qm-logo.png" alt="QM" width="120">+</p>-A multiplayer agent harness for work. In Slack and on the web.+<div align="center">-## Setup+**A multiplayer agent harness for work. In Slack and on the web.**<br>+Run it in your own cloud, with your own models and keys.-Tell your coding agent of choice `Let's deploy https://github.com/yc-software/qm`. From here, it should follow the deployment guide in this repo.+[](https://github.com/yc-software/qm/actions/workflows/cicd.yml)+[](./LICENSE)+[](./package.json)+[](https://www.npmjs.com/package/@yc-software/qm)-You can also try out a 3rd-party hosted version of QM [here](https://www.agent37.com/qm).+[Deploy](#deploy-it-for-your-org) · [How it works](#how-it-works) · [Security model](#security-and-secrets) · [Customize](#customize-your-instance) · [Contribute](#contributing) · [Documentation](#going-deeper)-If you're an infra provider interested in offering a hosted version of QM, feel free to reach out.+</div>-## What is QM?+## OverviewMost agents are designed like personal assistants. You can make one work for a wholecompany, but it quickly gets complex. QM is designed for startups. Employees each get@@ -23,6 +29,14 @@ It's built with open source in mind. Pick your own harness and model and switchthem. Pi, OpenCode, Codex, and Claude Code all drive the same core, so a deploymentisn't tied to any single vendor.+## Setup++Tell your coding agent of choice `Let's deploy https://github.com/yc-software/qm`. From here, it should follow the deployment guide in this repo.++You can also try out a 3rd-party hosted version of QM [here](https://www.agent37.com/qm).++If you're an infra provider interested in offering a hosted version of QM, feel free to reach out.+## Features- **Personal and shared scopes.** People customize the agent to be _theirs_, and still@@ -70,7 +84,7 @@ Use `npm run dev-instance:both` when testing both surfaces together. Bare`npm run dev-instance` defaults to web for new instances and preserves the surfaceon reload. Switch an existing instance with an explicit surface command.-## Architecture+## How it worksEvery turn runs through a central core, which can use a variety of models and harnessesto generate the response. A Postgres persistence layer holds user data, session history,diff --git a/docs/images/qm-logo.png b/docs/images/qm-logo.pngnew file mode 100644index 000000000..55d53707eBinary files /dev/null and b/docs/images/qm-logo.png differ