Skip to content

Commit f6759fc

Browse files
committed
Add branding assets and README hero
1 parent cc63917 commit f6759fc

7 files changed

Lines changed: 234 additions & 11 deletions

File tree

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,21 @@
66
[![GitHub stars](https://img.shields.io/github/stars/wimi321/task-bundle?style=social)](https://github.com/wimi321/task-bundle/stargazers)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
88

9+
![Task Bundle hero banner](./assets/hero-banner.svg)
10+
911
Turn AI coding runs into portable, replayable, benchmark-ready task bundles.
1012

13+
The missing middle layer between raw chat logs and heavyweight benchmark platforms.
14+
15+
Package a task once, inspect it later, compare tools on the same starting point, and generate benchmark-style reports from real artifacts.
16+
1117
Task Bundle is a TypeScript + Node.js CLI for teams building agents, evals, coding benchmarks, and reproducible AI workflows.
1218

13-
What makes it compelling:
14-
- package one coding task into a clean, shareable directory
15-
- compare outputs across tools and models with real metadata and artifact hashes
16-
- generate benchmark-style reports from a directory of bundles
17-
- keep enough context to rerun work later without pretending replay means token-perfect recording
19+
Why people star it:
20+
- turn one AI coding run into a clean, shareable directory instead of a screenshot, transcript, or loose patch
21+
- compare Codex, Claude Code, Cursor, or internal agents with real metadata, hashes, and outcome fields
22+
- generate benchmark-style reports from a folder of bundles without building a full evaluation platform first
23+
- keep replay grounded in re-execution and comparison, not token-by-token theater
1824

1925
If you've ever wanted a format between "a raw chat log" and "a full benchmark platform", this project is that missing middle layer.
2026

@@ -67,6 +73,7 @@ See:
6773
- [docs/bundle-format.zh-CN.md](./docs/bundle-format.zh-CN.md)
6874
- [docs/design-decisions.md](./docs/design-decisions.md)
6975
- [docs/replay-contract.md](./docs/replay-contract.md)
76+
- [docs/branding.md](./docs/branding.md)
7077

7178
## Five-Minute Demo
7279

README.zh-CN.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,21 @@
66
[![GitHub stars](https://img.shields.io/github/stars/wimi321/task-bundle?style=social)](https://github.com/wimi321/task-bundle/stargazers)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
88

9+
![Task Bundle hero banner](./assets/hero-banner.svg)
10+
911
把 AI coding 过程,变成可分享、可重跑、可比较、可做 benchmark 的任务包。
1012

13+
它是“原始聊天记录”和“重型 benchmark 平台”之间,那层真正好用的中间层。
14+
15+
一次打包,之后就能 inspect、compare、validate、report,也能把不同工具放到同一起点上做更公平的对照。
16+
1117
Task Bundle 是一个 TypeScript + Node.js CLI,适合 agent、eval、benchmark、可复现实验这类工作流。
1218

13-
它吸引人的地方在于
14-
- 能把一次 coding 任务整理成干净、稳定、可搬运的目录
15-
- 能在不同工具和模型之间做真实比较,不只是看聊天记录
16-
- 能从一组 bundle 直接生成 benchmark 风格报告
17-
- 能为后续 replay 保留足够上下文,但不假装逐 token 复刻才叫“可复现”
19+
大家愿意给它点 star,通常是因为这些点
20+
- 它能把一次 AI coding 任务整理成干净、稳定、可搬运的目录,而不是散落的截图、聊天记录或 patch
21+
- 它能比较 Codex、Claude Code、Cursor 或内部工具的结果,而且比较依据是真实元数据、哈希和 outcome 字段
22+
- 它能从一组 bundle 直接生成 benchmark 风格报告,不用一开始就搭完整评测平台
23+
- 它对 replay 的理解更务实,强调“可重跑、可比较”,而不是追求逐 token 复刻的表演感
1824

1925
如果你一直觉得“聊天记录太散、benchmark 平台太重”,这个项目就是中间那层缺失的基础设施。
2026

@@ -67,6 +73,7 @@ task-bundle/
6773
- [docs/bundle-format.md](./docs/bundle-format.md)
6874
- [docs/design-decisions.md](./docs/design-decisions.md)
6975
- [docs/replay-contract.md](./docs/replay-contract.md)
76+
- [docs/branding.md](./docs/branding.md)
7077

7178
## 五分钟演示
7279

assets/hero-banner.svg

Lines changed: 100 additions & 0 deletions
Loading

assets/social-preview.png

624 KB
Loading

assets/social-preview.svg

Lines changed: 81 additions & 0 deletions
Loading

docs/branding.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Branding Assets
2+
3+
Task Bundle includes repository-ready visual assets under `assets/`.
4+
5+
The art direction is intentionally warm-editorial rather than generic SaaS gradients: a calm dark field, paper-toned bundle cards, and a benchmark signal accent that reinforces "portable tasks" plus "measurable outcomes."
6+
7+
## Files
8+
9+
- `assets/hero-banner.svg`
10+
Embedded at the top of the README to make the repository landing page feel like a product, not just a package listing.
11+
- `assets/social-preview.svg`
12+
Source artwork for GitHub social preview uploads.
13+
- `assets/social-preview.png`
14+
Recommended raster export for GitHub social preview uploads. Kept in the repository for easy manual upload, but not required in the npm package.
15+
16+
## Suggested GitHub Setup
17+
18+
1. Open the repository settings page.
19+
2. Go to `General` -> `Social preview`.
20+
3. Upload `assets/social-preview.png`.
21+
22+
## Local Export Tips
23+
24+
If you want to regenerate the PNG on macOS, you can use Quick Look or another SVG-to-PNG tool. The repository artwork is intentionally kept as SVG so it stays editable and versionable, while the committed PNG keeps GitHub social preview setup friction low.

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,12 @@
3131
"dist",
3232
"examples",
3333
"docs",
34+
"assets/hero-banner.svg",
35+
"assets/social-preview.svg",
3436
"templates",
35-
"README.md"
37+
"LICENSE",
38+
"README.md",
39+
"README.zh-CN.md"
3640
],
3741
"scripts": {
3842
"build": "tsc -p tsconfig.json",

0 commit comments

Comments
 (0)