Skip to content

Commit 3335d41

Browse files
committed
Improve README styling
1 parent 2613a33 commit 3335d41

File tree

1 file changed

+71
-19
lines changed

1 file changed

+71
-19
lines changed

README.md

Lines changed: 71 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,94 @@
1-
# Loadout
1+
```
2+
██╗ ██████╗ █████╗ ██████╗ ██████╗ ██╗ ██╗████████╗
3+
██║ ██╔═══██╗██╔══██╗██╔══██╗██╔═══██╗██║ ██║╚══██╔══╝
4+
██║ ██║ ██║███████║██║ ██║██║ ██║██║ ██║ ██║
5+
██║ ██║ ██║██╔══██║██║ ██║██║ ██║██║ ██║ ██║
6+
███████╗╚██████╔╝██║ ██║██████╔╝╚██████╔╝╚██████╔╝ ██║
7+
╚══════╝ ╚═════╝ ╚═╝ ╚═╝╚═════╝ ╚═════╝ ╚═════╝ ╚═╝
8+
```
9+
10+
<div align="center">
11+
12+
[![Typing SVG](https://readme-typing-svg.demolab.com?font=Fira+Code&weight=500&size=20&duration=2500&pause=800&color=00FF00&center=true&vCenter=true&width=520&lines=%24+loadout+--help;manifest+%2B+lock+%2B+symlinks;codex+%7C+claude;agent-first+skill+management)](https://git.io/typing-svg)
13+
14+
![CI](https://img.shields.io/github/actions/workflow/status/t3chn/loadout/ci.yml?branch=main&style=flat-square&logo=github&logoColor=00ff00&label=ci&labelColor=000000&color=00ff00)
15+
![License](https://img.shields.io/github/license/t3chn/loadout?style=flat-square&label=license&labelColor=000000&color=00ff00)
16+
![Rust](https://img.shields.io/badge/rust-stable-000000?style=flat-square&logo=rust&logoColor=00ff00)
17+
![prek](https://img.shields.io/badge/prek-enabled-000000?style=flat-square&logo=pre-commit&logoColor=00ff00)
18+
![policy](https://img.shields.io/badge/policy-english--only-000000?style=flat-square&labelColor=000000&color=00ff00)
219

3-
Machine-first skill manager for project-scoped skills across Codex CLI and Claude Code.
20+
</div>
421

5-
## Problem
22+
---
623

7-
Projects frequently copy skills from a central skills repository. That creates drift:
24+
<details open>
25+
<summary><b>📌 ~/problem</b></summary>
26+
<br>
27+
28+
Projects often copy skills from a central skills repository. That creates drift:
829

930
- the project copy diverges from the source
10-
- improvements get lost or re-done
31+
- improvements get lost or duplicated
1132
- each client (Codex vs Claude) ends up with a different layout and UX
1233

13-
## What this repo does
34+
</details>
35+
36+
<details open>
37+
<summary><b>🧠 ~/solution</b></summary>
38+
<br>
1439

1540
Loadout makes skill usage reproducible and agent-friendly:
1641

17-
- Uses a **manifest + lock** (pinned commit SHAs) committed in the project.
18-
- Clones skill sources into a **gitignored runtime cache** per project.
19-
- Exports selected skills into `.codex/skills/` and `.claude/skills/` via **symlinks**.
20-
- Enforces **explicit trust** for third-party sources (supply-chain gating).
21-
- Outputs **JSON by default** (including errors), so agents can parse reliably.
42+
- **manifest + lock** (pinned commit SHAs) committed in the project
43+
- per-project source clones in `.codex/.loadout/` (gitignored)
44+
- symlink export into `.codex/skills/` and `.claude/skills/`
45+
- explicit trust gate for third-party sources
46+
- JSON by default on stdout (including errors)
47+
48+
Docs:
49+
50+
- `docs/PRD_Skill_Manager.md`
51+
- `docs/Agent_Playbook.md`
2252

23-
## Project layout
53+
</details>
2454

25-
- `src/``loadout` CLI (Rust)
26-
- `src/bin/no_cyrillic.rs` — repo policy check: English-only (no Cyrillic)
27-
- `docs/` — PRD + agent playbook
28-
- `templates/user-scoped/` — user-scoped wrapper skill templates
55+
<details>
56+
<summary><b>🚀 ~/quickstart</b></summary>
57+
<br>
2958

30-
## Quick start (local dev)
59+
```bash
60+
# in a git project
61+
loadout init --primary-url <skills_repo_url> --primary-ref main
62+
63+
loadout suggest --target codex --query "pdf" --limit 10
64+
loadout add --target codex pdf-processing
65+
66+
# if you select third-party skills, you must trust the source explicitly
67+
loadout source trust third --yes
68+
```
69+
70+
</details>
71+
72+
<details>
73+
<summary><b>🧪 ~/dev</b></summary>
74+
<br>
3175

3276
```bash
3377
cargo test
3478
uvx prek run --all-files
3579
```
3680

37-
## Notes
81+
</details>
82+
83+
---
84+
85+
<details>
86+
<summary><b>🗒️ ~/notes</b></summary>
87+
<br>
88+
89+
- v1 targets macOS/Linux (symlink export). Windows fallback export is a roadmap item.
3890

39-
- v1 targets macOS/Linux. Windows fallback export is a roadmap item.
91+
</details>
4092

4193
## License
4294

0 commit comments

Comments
 (0)