| # Instructions for writing the README.md |
|
|
| The readme should be visually interesting, to the point, not too long. |
| Use the copy from the website in cases where we need some. |
|
|
| - gives the pitch why, e.g. from the homepage. |
|
|
| ## Outline |
|
|
| - image header up top |
| - Paperclip |
| - Manage autonomous AI Businesses |
| - The open-source AI-agent orchestrator teams of agents that run companies |
|
|
| - a video |
|
|
| # What is it |
|
|
| Paperclip is a node server & UI that orchestrates a team of agents to run businesses. |
|
|
| Bring-your-own agents, assign goals, and track your agent's work and costs. |
|
|
| It looks like a task manager but has specialized skills and agent coordination |
|
|
| **It's high taste, and feels good to use** |
|
|
| # Paperclip is right for you if: |
|
|
| - You want to build autonomous companies |
| - You want to coordinate many different types agents (OpenClaw, Codex, Claude, Cursor, etc.) to collaborate towards a common goal |
| - You have 20 simultaneous Claude Code terminals open (and lose track of what everyone is working on) |
| - You want to let your agents run autonomously 24/7, but still audit their work and chime in when needed |
| - You want to monitor costs |
| - You want a process for managing your agents that feels like using a task manager |
| - You want to manage your autonomous businesses from your phone |
|
|
| # What is not |
|
|
| Paperclip is not: |
|
|
| - a code review tool |
| - opinionated about what agent you use |
|
|
| # the problem |
|
|
| If you want to be maximally effective with agents, you need to |
|
|
| # quickstart |
|
|
| # faq |
|
|
| # comparison |
|
|
| # contributing |
|
|
| # community |
|
|
| # license |
|
|
| # footer |
|
|
| ## Examples: |
|
|
| - https://github.com/klawsh/klaw.sh - nice header, nice tables |
| - what is it |
| - the problem |
| - quickstart |
| - faq |
| - comparison |
| - contributing |
| - community |
| - license |
| - footer |
| - https://github.com/nearai/ironclaw - nice header |
| - philosophy |
| - https://github.com/TinyAGI/tinyclaw - nice header, nice video |
| - https://github.com/ryoppippi/ccusage - nice header, |
| - https://github.com/can1357/oh-my-pi - a little long |
|
|
