|
1 | | -<!-- ============================================================================ |
2 | | - TEMPLATE CHECKLIST - Remove this entire block after completing setup |
3 | | - ============================================================================ |
4 | | -
|
5 | | -## Getting Started |
6 | | -
|
7 | 1 | > **⚠️ Do not clone this repository directly!** |
8 | 2 | > |
9 | 3 | > Use `formae plugin init` to create your plugin. This command scaffolds a new |
|
13 | 7 | > formae plugin init my-plugin |
14 | 8 | > ``` |
15 | 9 |
|
| 10 | +<!-- ============================================================================ |
| 11 | + TEMPLATE CHECKLIST - Remove this block and the warning above after setup |
| 12 | + ============================================================================ |
| 13 | +
|
| 14 | +## Setup Checklist |
| 15 | +
|
16 | 16 | After creating your plugin with `formae plugin init`, complete these steps: |
17 | 17 |
|
18 | 18 | - [ ] Update `formae-plugin.pkl` with your plugin metadata (name, namespace, description) |
19 | 19 | - [ ] Define your resource types in `schema/pkl/*.pkl` |
20 | 20 | - [ ] Implement CRUD operations in `plugin.go` |
21 | 21 | - [ ] Update test fixtures in `testdata/*.pkl` to use your resources |
22 | | -- [ ] Update this README (see below - replace title, description, resources, etc.) |
23 | | -- [ ] Set up local credentials for testing (see Development section) |
| 22 | +- [ ] Update this README (replace title, description, resources table, etc.) |
| 23 | +- [ ] Set up local credentials for testing |
24 | 24 | - [ ] Run conformance tests locally: `make conformance-test` |
25 | 25 | - [ ] Configure CI credentials in `.github/workflows/ci.yml` (optional) |
26 | | -- [ ] Remove this "Getting Started" checklist section |
| 26 | +- [ ] Remove the warning box above and this checklist section |
27 | 27 |
|
28 | 28 | For detailed guidance, see the [Plugin SDK Documentation](https://docs.formae.io/plugin-sdk). |
29 | 29 |
|
30 | | - ============================================================================ |
31 | | - END TEMPLATE CHECKLIST - Everything below is YOUR plugin's README |
32 | 30 | ============================================================================ --> |
33 | 31 |
|
34 | 32 | # Example Plugin for Formae |
|
0 commit comments