docs: add README, draft README, and adapter logo assets
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
78
doc/README-draft.md
Normal file
78
doc/README-draft.md
Normal file
@@ -0,0 +1,78 @@
|
||||
# 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
|
||||
5
doc/assets/logos/bash.svg
Normal file
5
doc/assets/logos/bash.svg
Normal file
@@ -0,0 +1,5 @@
|
||||
<svg viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<rect x="1" y="1" width="30" height="30" rx="6" fill="#2d2d2d"/>
|
||||
<polyline points="9,11 14,16 9,21" fill="none" stroke="#4af626" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
|
||||
<line x1="16" y1="21" x2="23" y2="21" stroke="#4af626" stroke-width="2" stroke-linecap="round"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 378 B |
3
doc/assets/logos/claude.svg
Normal file
3
doc/assets/logos/claude.svg
Normal file
@@ -0,0 +1,3 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" fill="#D97757">
|
||||
<path d="m3.127 10.604 3.135-1.76.053-.153-.053-.085H6.11l-.525-.032-1.791-.048-1.554-.065-1.505-.08-.38-.081L0 7.832l.036-.234.32-.214.455.04 1.009.069 1.513.105 1.097.064 1.626.17h.259l.036-.105-.089-.065-.068-.064-1.566-1.062-1.695-1.121-.887-.646-.48-.327-.243-.306-.104-.67.435-.48.585.04.15.04.593.456 1.267.981 1.654 1.218.242.202.097-.068.012-.049-.109-.181-.9-1.626-.96-1.655-.428-.686-.113-.411a2 2 0 0 1-.068-.484l.496-.674L4.446 0l.662.089.279.242.411.94.666 1.48 1.033 2.014.302.597.162.553.06.17h.105v-.097l.085-1.134.157-1.392.154-1.792.052-.504.25-.605.497-.327.387.186.319.456-.045.294-.19 1.23-.37 1.93-.243 1.29h.142l.161-.16.654-.868 1.097-1.372.484-.545.565-.601.363-.287h.686l.505.751-.226.775-.707.895-.585.759-.839 1.13-.524.904.048.072.125-.012 1.897-.403 1.024-.186 1.223-.21.553.258.06.263-.218.536-1.307.323-1.533.307-2.284.54-.028.02.032.04 1.029.098.44.024h1.077l2.005.15.525.346.315.424-.053.323-.807.411-3.631-.863-.872-.218h-.12v.073l.726.71 1.331 1.202 1.667 1.55.084.383-.214.302-.226-.032-1.464-1.101-.565-.497-1.28-1.077h-.084v.113l.295.432 1.557 2.34.08.718-.112.234-.404.141-.444-.08-.911-1.28-.94-1.44-.759-1.291-.093.053-.448 4.821-.21.246-.484.186-.403-.307-.214-.496.214-.98.258-1.28.21-1.016.19-1.263.112-.42-.008-.028-.092.012-.953 1.307-1.448 1.957-1.146 1.227-.274.109-.477-.247.045-.44.266-.39 1.586-2.018.956-1.25.617-.723-.004-.105h-.036l-4.212 2.736-.75.096-.324-.302.04-.496.154-.162 1.267-.871z"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.5 KiB |
4
doc/assets/logos/codex.svg
Normal file
4
doc/assets/logos/codex.svg
Normal file
@@ -0,0 +1,4 @@
|
||||
<svg viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<circle cx="16" cy="16" r="15" fill="#000"/>
|
||||
<path d="M16 6L16 26M11 11L16 6L21 11M11 21L16 26L21 21" stroke="#fff" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 268 B |
4
doc/assets/logos/cursor.svg
Normal file
4
doc/assets/logos/cursor.svg
Normal file
@@ -0,0 +1,4 @@
|
||||
<svg viewBox="0 0 512 512" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<rect width="512" height="512" rx="128" fill="#14120b"/>
|
||||
<path d="m415.035 156.35-151.503-87.47c-4.865-2.81-10.868-2.81-15.733 0l-151.497 87.47c-4.09 2.36-6.615 6.73-6.615 11.46v176.38c0 4.73 2.525 9.1 6.615 11.46l151.504 87.47c4.865 2.81 10.868 2.81 15.733 0l151.504-87.47c4.089-2.36 6.614-6.73 6.614-11.46V167.81c0-4.73-2.525-9.1-6.614-11.46zm-9.516 18.53-146.255 253.32c-.988 1.71-3.599 1.01-3.599-.97V261.36c0-3.31-1.771-6.38-4.644-8.04l-143.645-82.93c-1.707-.99-1.01-3.6.968-3.6h292.509c4.154 0 6.75 4.5 4.673 8.1h-.007z" fill="#edecec"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 630 B |
7
doc/assets/logos/http.svg
Normal file
7
doc/assets/logos/http.svg
Normal file
@@ -0,0 +1,7 @@
|
||||
<svg viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<circle cx="16" cy="16" r="14" stroke="#3b82f6" stroke-width="2"/>
|
||||
<ellipse cx="16" cy="16" rx="6" ry="14" stroke="#3b82f6" stroke-width="1.5"/>
|
||||
<line x1="2" y1="16" x2="30" y2="16" stroke="#3b82f6" stroke-width="1.5"/>
|
||||
<line x1="4" y1="9" x2="28" y2="9" stroke="#3b82f6" stroke-width="1" opacity="0.6"/>
|
||||
<line x1="4" y1="23" x2="28" y2="23" stroke="#3b82f6" stroke-width="1" opacity="0.6"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 482 B |
17
doc/assets/logos/openclaw.svg
Normal file
17
doc/assets/logos/openclaw.svg
Normal file
@@ -0,0 +1,17 @@
|
||||
<svg viewBox="0 0 120 120" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<defs>
|
||||
<linearGradient id="lobster-grad" x1="0%" y1="0%" x2="100%" y2="100%">
|
||||
<stop offset="0%" stop-color="#ff4d4d"/>
|
||||
<stop offset="100%" stop-color="#991b1b"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<path d="M60 10C30 10 15 35 15 55C15 75 30 95 45 100L45 110L55 110L55 100C55 100 60 102 65 100L65 110L75 110L75 100C90 95 105 75 105 55C105 35 90 10 60 10Z" fill="url(#lobster-grad)"/>
|
||||
<path d="M20 45C5 40 0 50 5 60C10 70 20 65 25 55C28 48 25 45 20 45Z" fill="url(#lobster-grad)"/>
|
||||
<path d="M100 45C115 40 120 50 115 60C110 70 100 65 95 55C92 48 95 45 100 45Z" fill="url(#lobster-grad)"/>
|
||||
<path d="M45 15Q35 5 30 8" stroke="#ff4d4d" stroke-width="3" stroke-linecap="round"/>
|
||||
<path d="M75 15Q85 5 90 8" stroke="#ff4d4d" stroke-width="3" stroke-linecap="round"/>
|
||||
<circle cx="45" cy="35" r="6" fill="#1a1a2e"/>
|
||||
<circle cx="75" cy="35" r="6" fill="#1a1a2e"/>
|
||||
<circle cx="46" cy="34" r="2.5" fill="#00e5cc"/>
|
||||
<circle cx="76" cy="34" r="2.5" fill="#00e5cc"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.0 KiB |
Reference in New Issue
Block a user