Skip to content

Commit f88adba

Browse files
committed
Document the bundled library skill (README + docs); fix changelog wording
1 parent 722f3cc commit f88adba

3 files changed

Lines changed: 22 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,18 @@ Or with uv:
7070
uv add crudauth
7171
```
7272

73+
## AI agents (library skill)
74+
75+
crudauth ships a [library skill](https://library-skills.io) embedded in the package, so AI coding
76+
agents follow its actual conventions and gotchas (account shapes, gates, recovery, custom email
77+
bodies, production wiring) in sync with the version you installed. After adding crudauth, install it
78+
into your project:
79+
80+
```bash
81+
uvx library-skills # scans deps, links bundled skills (re-run to keep them in sync on upgrade)
82+
uvx library-skills --claude # for Claude Code (.claude/skills)
83+
```
84+
7385
## Quickstart
7486

7587
Sessions are the default - no `transports=` needed. You get cookie auth, CSRF,

docs/changelog.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,11 @@ branded HTML for the verify / reset / change emails instead of delivering crudau
1818
an XSS or credential-leak vector. `context.link` is the same assembled URL as in `body` (one
1919
source). Per-user personalization (`Hi Alice`) stays a `DeliveryChannel` concern (it has the `db`
2020
handle and owns escaping).
21-
- **Bundled Agent Skill** (`crudauth/.agents/skills/crudauth/`): crudauth now ships a
22-
[library skill](https://agentskills.io), so AI coding agents that support the format get crudauth's
23-
conventions and gotchas (account shapes, gates, recovery, custom email bodies, production wiring) on
24-
demand when working in a project that depends on it. Installed automatically with the package.
21+
- **Bundled library skill** (`crudauth/.agents/skills/crudauth/`): crudauth now ships an embedded
22+
[library skill](https://library-skills.io), so AI coding agents follow crudauth's actual conventions
23+
and gotchas (account shapes, gates, recovery, custom email bodies, production wiring) in sync with the
24+
installed version. It travels in the wheel; install it into your project's agent with
25+
`uvx library-skills` (add `--claude` for Claude Code).
2526

2627
#### Breaking changes
2728
- **`EmailSender.send` gains a required `context` parameter.** Add it to your `send` signature

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,11 @@
7272

7373
For OAuth, Redis, and device parsing, install the extras: `pip install "crudauth[all]"`.
7474

75+
CRUDAuth ships a [library skill](https://library-skills.io) embedded in the package, so AI coding
76+
agents follow its actual conventions in sync with the installed version. Install it into your project
77+
with `uvx library-skills` (add `--claude` for Claude Code); re-run it after upgrading to keep the
78+
skill current.
79+
7580
### 2. Mount the router
7681

7782
Sessions are the default - no `transports=` needed. You get cookie auth, CSRF,

0 commit comments

Comments
 (0)