From af67f1fe4f75abf250afad8b6c59c3f46dfe4c00 Mon Sep 17 00:00:00 2001 From: Kiet <31864905+Kitenite@users.noreply.github.com> Date: Wed, 24 Dec 2025 21:38:23 -0800 Subject: [PATCH] Refactor README for better structure and clarity Updated README to improve clarity and organization of usage instructions and images. --- README.md | 28 ++++++++-------------------- 1 file changed, 8 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index f18122162bc..8d49a3191a1 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Run 10+ CLI coding agents like Claude Code, Codex, etc. in parallel on your machine. Spin up new coding tasks while waiting for your current agent to finish. Quickly switch between tasks as they need your attention. -example +https://github.com/user-attachments/assets/2c06d187-7e85-483a-92d3-d0078d440626 ## Getting Started @@ -59,33 +59,21 @@ open apps/desktop/release ### Usage -For each parallel tasks, Superset uses git worktrees to clone a new branch on your machine. Automate copying env variables, installing dependencies, etc. through a config file (`.superset/config.json`) - -
- Creating a worktree -
-
- - +For each parallel tasks, Superset uses git worktrees to clone a new branch on your machine. Automate copying env variables, installing dependencies, etc. through a config file (`.superset/config.json`). Each workspace gets their own organized terminal system. You can create default presets. +Screenshot 2025-12-24 at 9 33 35 PM -
- Managing terminals -
-
+Superset monitors your running agents, notify you when changes are ready, and help coordinate between multiple agents. There's a diff view with editor built in so you can quickly inspect and edit agents' changes. -Superset monitors your running processes, notify you when changes are ready, and help coordinate between multiple agents. +Screenshot 2025-12-24 at 9 33 51 PM +Superet is designed to be a superset of your existing tools. It works for any CLI agents that runs in the terminal. You can open your superset workspace in any apps like IDE, filesystem, terminal, etc. -
-Notifications -
-
+Screenshot 2025-12-24 at 9 34 04 PM ### Tech Stack - [![Electron](https://img.shields.io/badge/Electron-191970?logo=Electron&logoColor=white)](https://www.electronjs.org/) [![React](https://img.shields.io/badge/React-%2320232a.svg?logo=react&logoColor=%2361DAFB)](https://reactjs.org/) [![TailwindCSS](https://img.shields.io/badge/Tailwindcss-%2338B2AC.svg?logo=tailwind-css&logoColor=white)](https://tailwindcss.com/) @@ -153,4 +141,4 @@ Distributed under the Apache 2.0 License. See [LICENSE.md](LICENSE.md) for more [Electron-url]: https://www.electronjs.org/ [Vite.js]: https://img.shields.io/badge/vite-%23646CFF.svg?logo=vite&logoColor=white [Vite-url]: https://vitejs.dev/ -[product-screenshot]: assets/brand.png \ No newline at end of file +[product-screenshot]: assets/brand.png