Skip to content

Commit 49ed1f7

Browse files
committed
fix: move warning outside HTML comment so it renders on GitHub
1 parent 494e529 commit 49ed1f7

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
<!-- ============================================================================
2-
TEMPLATE CHECKLIST - Remove this entire block after completing setup
3-
============================================================================
4-
5-
## Getting Started
6-
71
> **⚠️ Do not clone this repository directly!**
82
>
93
> Use `formae plugin init` to create your plugin. This command scaffolds a new
@@ -13,22 +7,26 @@
137
> formae plugin init my-plugin
148
> ```
159
10+
<!-- ============================================================================
11+
TEMPLATE CHECKLIST - Remove this block and the warning above after setup
12+
============================================================================
13+
14+
## Setup Checklist
15+
1616
After creating your plugin with `formae plugin init`, complete these steps:
1717
1818
- [ ] Update `formae-plugin.pkl` with your plugin metadata (name, namespace, description)
1919
- [ ] Define your resource types in `schema/pkl/*.pkl`
2020
- [ ] Implement CRUD operations in `plugin.go`
2121
- [ ] 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
2424
- [ ] Run conformance tests locally: `make conformance-test`
2525
- [ ] 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
2727
2828
For detailed guidance, see the [Plugin SDK Documentation](https://docs.formae.io/plugin-sdk).
2929
30-
============================================================================
31-
END TEMPLATE CHECKLIST - Everything below is YOUR plugin's README
3230
============================================================================ -->
3331
3432
# Example Plugin for Formae

0 commit comments

Comments
 (0)