Skip to content

Commit 2f67a51

Browse files
committed
Tidy README landing section
1 parent 2df8d05 commit 2f67a51

1 file changed

Lines changed: 10 additions & 19 deletions

File tree

README.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,37 +10,28 @@
1010
[![Demo Repo](https://img.shields.io/badge/demo-codexopt--demo-0f766e)](https://github.com/SuperagenticAI/codexopt-demo)
1111
[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
1212

13-
CodexOpt: Optimize your Agents.MD and Skills for Codex with GEPA
13+
CodexOpt is a lightweight CLI for benchmarking and optimizing Codex instruction assets.
1414

15-
## Demo Repo
15+
It focuses on two repo-local files:
1616

17-
Want to see CodexOpt on a small, intentionally messy repository with sample
18-
`AGENTS.md`, demo skills, `tasks.md`, and `issues.md`?
19-
20-
- Demo: https://github.com/SuperagenticAI/codexopt-demo
21-
22-
## Documentation
23-
24-
- Docs site: https://superagenticai.github.io/CodexOpt/
25-
- Docs source: [`docs/`](/Users/shashi/oss/CodexOpt/docs)
17+
- `AGENTS.md`
18+
- `.codex/skills/**/SKILL.md`
2619

27-
View the published documentation:
20+
## Quick Links
2821

29-
- https://superagenticai.github.io/CodexOpt/
22+
- Documentation: https://superagenticai.github.io/CodexOpt/
23+
- Demo repository: https://github.com/SuperagenticAI/codexopt-demo
24+
- PyPI package: https://pypi.org/project/codexopt/
25+
- Docs source: [docs/](/Users/shashi/oss/CodexOpt/docs)
3026

31-
CodexOpt is a lightweight Python CLI to improve Codex instruction assets with a repeatable loop:
27+
CodexOpt gives teams a repeatable workflow to:
3228

3329
1. Scan instruction files.
3430
2. Benchmark quality.
3531
3. Generate optimized candidates.
3632
4. Apply only improvements.
3733
5. Produce a report.
3834

39-
It targets:
40-
41-
- `AGENTS.md`
42-
- `.codex/skills/**/SKILL.md`
43-
4435
## Why CodexOpt
4536

4637
Most teams edit `AGENTS.md` and `SKILL.md` manually, but struggle to answer:

0 commit comments

Comments
 (0)