Skip to content

Commit 75c364a

Browse files
andresdjassoclaudewaleedlatif1
authored
improvement(docs): README redesign — banner + platform screenshot (#5283)
* docs(readme): n8n-style restructure — static banner + platform screenshot Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs(readme): platform shot as one white window (chat left, workflow right) on off-white Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs(readme): platform shot — show a chat conversation in the left pane Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs(readme): platform shot — capture the REAL chat-everywhere two-pane (one window) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs(readme): add workspace surface showcase + collapse tech stack Add a compact 2x2 grid after Capabilities showing the surfaces beyond the chat+workflow hero — Tables, Files, Knowledge, and Scheduled tasks — reusing the cohesive product screenshots from the July newsletter (downsized + optimized). Collapse the Tech Stack list into a <details> so the lower half stays short. Screenshots sit below the meat (Capabilities) as bar/grid imagery, not a wall up top. --------- Co-authored-by: andresdjasso <andresdjasso@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: waleed <walif6@gmail.com>
1 parent fbcdcd0 commit 75c364a

9 files changed

Lines changed: 34 additions & 2 deletions

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<p align="center">
1414
<a href="https://sim.ai" target="_blank" rel="noopener noreferrer">
15-
<img src="apps/sim/public/static/readme-hero.gif" alt="Sim — your workflow agent for solving automations. Build, deploy, and manage AI agents visually, conversationally, or with code." width="100%"/>
15+
<img src="apps/sim/public/static/readme-banner.png" alt="Sim — Integrate, Context, Build, and Monitor AI agents" width="100%"/>
1616
</a>
1717
</p>
1818

@@ -35,7 +35,7 @@ Open [http://localhost:3000](http://localhost:3000)
3535
Docker must be installed and running. Use `-p, --port <port>` to run Sim on a different port, or `--no-pull` to skip pulling the latest Docker images.
3636

3737
<p align="center">
38-
<img src="apps/sim/public/static/readme-tour.gif" alt="How Sim worksIntegrate, Context, Build, Monitor — shown end to end: start a chat to build an agent, connect Slack and other integrations, add a knowledge base, build the workflow visually, deploy it, and monitor runs in the logs" width="100%"/>
38+
<img src="apps/sim/public/static/readme-platform.png" alt="The Sim platform — chat on the left, the visual workflow builder on the right" width="100%"/>
3939
</p>
4040

4141
## Capabilities
@@ -46,6 +46,33 @@ Docker must be installed and running. Use `-p, --port <port>` to run Sim on a di
4646
- Ingest files, knowledge bases, and structured table data
4747
- Monitor runs, logs, schedules, and workflow activity
4848

49+
## One workspace, every surface
50+
51+
<p align="center">Chat and workflows are just the start — tables, files, knowledge, and scheduled tasks all live in the same workspace.</p>
52+
53+
<table>
54+
<tr>
55+
<td width="50%" valign="top">
56+
<img src="apps/sim/public/static/readme-tables.png" alt="Tables in Sim — structured data your agents can query" width="100%"/>
57+
<p align="center"><b>Tables</b> — a database, built in</p>
58+
</td>
59+
<td width="50%" valign="top">
60+
<img src="apps/sim/public/static/readme-files.png" alt="Files in Sim — documents for your team and every agent" width="100%"/>
61+
<p align="center"><b>Files</b> — one store for your team and every agent</p>
62+
</td>
63+
</tr>
64+
<tr>
65+
<td width="50%" valign="top">
66+
<img src="apps/sim/public/static/readme-knowledge.png" alt="Knowledge bases in Sim — synced docs your agents can search" width="100%"/>
67+
<p align="center"><b>Knowledge</b> — your agents' memory</p>
68+
</td>
69+
<td width="50%" valign="top">
70+
<img src="apps/sim/public/static/readme-scheduled-tasks.png" alt="Scheduled tasks in Sim — recurring agent runs on a calendar" width="100%"/>
71+
<p align="center"><b>Scheduled tasks</b> — runs on your schedule</p>
72+
</td>
73+
</tr>
74+
</table>
75+
4976
## Self-hosting
5077

5178
### Docker Compose
@@ -120,6 +147,9 @@ See the [environment variables reference](https://docs.sim.ai/self-hosting/envir
120147

121148
## Tech Stack
122149

150+
<details>
151+
<summary>Next.js · Bun · PostgreSQL · Drizzle · Better Auth · Tailwind — and the rest of the stack</summary>
152+
123153
- **Framework**: [Next.js](https://nextjs.org/) (App Router)
124154
- **Runtime**: [Bun](https://bun.sh/)
125155
- **Database**: PostgreSQL with [Drizzle ORM](https://orm.drizzle.team)
@@ -136,6 +166,8 @@ See the [environment variables reference](https://docs.sim.ai/self-hosting/envir
136166
- **Remote Code Execution**: [E2B](https://www.e2b.dev/)
137167
- **Isolated Code Execution**: [isolated-vm](https://github.com/laverdet/isolated-vm)
138168

169+
</details>
170+
139171
## Contributing
140172

141173
We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for details.
76.4 KB
Loading
189 KB
Loading
-92.2 KB
Binary file not shown.
183 KB
Loading
192 KB
Loading
199 KB
Loading
241 KB
Loading
-1.31 MB
Binary file not shown.

0 commit comments

Comments
 (0)