Skip to content

Commit 2ff7be0

Browse files
authored
Merge pull request #21 from OasAIStudio/docs/readme-top-banner
Add README top banner
2 parents a5bdb29 + 19ca852 commit 2ff7be0

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

.github/media/demo.png

1.51 MB
Loading

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
`symphony-ts` is a TypeScript implementation of the original
99
[openai/symphony](https://github.com/openai/symphony) project.
1010

11+
It starts with Linear and is designed to support additional tracker platforms over time.
12+
1113
It is an orchestration service for agent-driven software delivery: it reads work from your tracker,
1214
creates a dedicated workspace for each issue, runs a coding agent inside that boundary, and gives
1315
operators a clean surface for runtime visibility, retries, and control.
@@ -19,10 +21,19 @@ moving from managing coding agents to managing work that needs to get done.
1921
> [!WARNING]
2022
> Symphony is intended for trusted environments.
2123
22-
<!-- Demo preview goes here -->
24+
![Symphony demo showing Linear issue tracking alongside the Symphony observability dashboard](.github/media/demo.png)
2325

2426
## Running Symphony
2527

28+
## RoadMap
29+
30+
| Item | Status |
31+
| --- | --- |
32+
| Implement Symphony and Linear integration | ✅ Complete |
33+
| Support more platforms | 🟡 Planned |
34+
| Support a local board GUI | 🟡 Planned |
35+
| Support more coding agents such as Claude Code scheduling | 🟡 Planned |
36+
2637
### Requirements
2738

2839
- Node.js `>= 22`
@@ -102,5 +113,5 @@ Implement the task, validate the result, and stop at the required handoff state.
102113
## Contributing
103114

104115
If you are extending this TypeScript implementation, keep changes aligned with the upstream product
105-
model in [`SPEC.upstream.md`](/Users/wangruobing/Personal/symwork/symphony/SPEC.upstream.md) and
106-
follow the repository workflow documented in [`AGENTS.md`](/Users/wangruobing/Personal/symwork/symphony/AGENTS.md).
116+
model in [`SPEC.upstream.md`](SPEC.upstream.md) and follow the repository workflow documented in
117+
[`AGENTS.md`](AGENTS.md).

0 commit comments

Comments
 (0)