diff --git a/README.md b/README.md index af413f29c8d..81988d18511 100644 --- a/README.md +++ b/README.md @@ -10,52 +10,49 @@ -Superset helps you run 100 CLI coding agents on your machine without losing your mind. - -## Docs - -See the Markdown wiki in `docs/`: [docs/README.md](docs/README.md). +## Motivation +What do you do when your coding agent is running? Our answer is to start another coding task in parallel. The best developer can run 10+ tasks in parallel. +With Superset, you can run 100. ## What you can do with Superset: - [X] Create and organize parallel coding environment -- [X] Notify you when agents need your review -- [ ] Share context between different CLI agents -- [ ] Manage a lot of agents in parallel -- [ ] Create and clone your standard environment -- [ ] Seemlessly transition between local and cloud so you can code on the go -- [ ] Automate reviewing and adjusting with minimal input +- [X] Get notified when an agent needs your review +- [ ] Share context between your agents +- [ ] Code on the go with a cloud environment +- [ ] Automate reviewing and feedback +- [ ] Create and manage Git pull requests -example-min +example-min ## Getting Started + [Download the app](https://superset.sh) or [run locally](https://superset.sh). ### Usage -Superset creates a new workspace for each of your tasks. Each workspace is isolated and parallel. - - -
+For each parallel tasks, Superset uses git worktree to clone a new branch on your machine. -We automatically set up your workspace by cloning env variables, installing dependencies, etc. +Automate copying env variables, installing dependencies, etc. through the app or with a setup script `./superset/setup.json` - +
-Coding agents can be spun up and organized. They can pass messages between each other ping you when they are done. +Each workspace gets their own organized terminal system. You can create default presets. - +
-Superset gives you a high level view of all the changes made and help you create and merge a PR in a few clicks +Superset monitors your running processes, notify you when changes are ready, and help coordinate between multiple agents. + +
### Our Tech Stack @@ -80,13 +77,15 @@ create a pull request. You can also See the [CONTRIBUTING.md](CONTRIBUTING.md) for instructions and code of conduct. -#### Contributors - -## Team +## Cookbook + +See tips and motivation under `docs`: [docs/cookbook/README.md](docs/cookbook/README.md). + +## Contact Us - [![Kiet Twitter](https://img.shields.io/badge/Kiet-@flyakiet-555?logo=x)](https://x.com/flyakiet) - [![Satya Twitter](https://img.shields.io/badge/Satya-@saddle_paddle-555?logo=x)](https://x.com/saddle_paddle) - [![Avi Twitter](https://img.shields.io/badge/Avi-@avimakesrobots-555?logo=x)](https://x.com/avimakesrobots) diff --git a/assets/example.png b/assets/example.png new file mode 100644 index 00000000000..ad392ccac5f Binary files /dev/null and b/assets/example.png differ diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 9490a2c83fb..00000000000 --- a/docs/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Superset Wiki -A collection of docs for Superset \ No newline at end of file diff --git a/docs/cookbook/README.md b/docs/cookbook/README.md index 822bc9f8d73..32e11f26e31 100644 --- a/docs/cookbook/README.md +++ b/docs/cookbook/README.md @@ -86,3 +86,23 @@ Plan as a separate step: ### Code Quality Linter, unit tests, and type-safety can be huge help. This gives valuable feedback to agents. + + + \ No newline at end of file