Skip to content

Commit a0f84c6

Browse files
authored
update readme to mention ai coding skills (#29)
1 parent 5d56b8e commit a0f84c6

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- [**Upgrade an existing pattern repository:**](#upgrade-an-existing-pattern-repository)
1919
- [Understanding Secrets Management](#understanding-secrets-management)
2020
- [Generated Files](#generated-files)
21+
- [AI Coding Skills](#ai-coding-skills)
2122
- [Development \& Contributing](#development--contributing)
2223
- [Prerequisites](#prerequisites)
2324
- [Local Development Workflow](#local-development-workflow)
@@ -136,12 +137,22 @@ Running `patternizer init` creates the following:
136137
- `Makefile`: A simple Makefile that includes `Makefile-common`.
137138
- `Makefile-common`: The core Makefile with all pattern-related targets.
138139
- `ansible.cfg`: Configuration for the ansible installation used when `./pattern.sh` is called
140+
- `.claude/skills/pattern-author/`: AI coding skill for Claude Code (see [AI Coding Skills](#ai-coding-skills))
141+
- `.cursor/skills/pattern-author/`: AI coding skill for Cursor (see [AI Coding Skills](#ai-coding-skills))
139142

140143
Using the `--with-secrets` flag additionally creates:
141144

142145
- `values-secret.yaml.template`: A template for defining your secrets.
143146
- It also updates `values-global.yaml` to set `global.secretLoader.disabled: false` and adds Vault and External Secrets Operator to the cluster group values.
144147

148+
### AI Coding Skills
149+
150+
Both `init` and `upgrade` install the **pattern-author** skill into your pattern repository. This skill teaches AI coding assistants how to work with Validated Patterns — including the values file structure, operator subscriptions, secrets framework, and hub/spoke configuration.
151+
152+
The skill is installed for both [Claude Code](https://docs.anthropic.com/en/docs/claude-code) and [Cursor](https://cursor.com/) using the [Agent Skills](https://cursor.com/docs/skills) open standard. The same skill files work in both tools. Any existing skills or configuration you have in your `.claude/` or `.cursor/` directories are left untouched.
153+
154+
To use the skill, open your pattern repository in Claude Code or Cursor and ask the assistant to help with pattern authoring tasks — for example, adding an operator, configuring secrets, or setting up a spoke cluster.
155+
145156
## Development & Contributing
146157

147158
This section is for developers who want to contribute to the Patternizer project itself.

0 commit comments

Comments
 (0)