Skip to content

Commit 969cc1e

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

File tree

3 files changed

+16
-113
lines changed

3 files changed

+16
-113
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,7 @@ dist/
2828
.pkl-cache/
2929
*.pkl-expected.pcf
3030
PklProject.deps.json
31+
32+
# Claude Code
33+
CLAUDE.md
34+
.claude/

CLAUDE.md

Lines changed: 0 additions & 99 deletions
This file was deleted.

README.md

Lines changed: 12 additions & 14 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,27 +7,31 @@
137
> formae plugin init my-plugin
148
> ```
159
10+
---
11+
12+
## Setup Checklist
13+
14+
*Remove this section and the warning above after completing setup.*
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 this checklist section and the warning box above
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
32-
============================================================================ -->
30+
---
3331
3432
# Example Plugin for Formae
3533
36-
<!-- TODO: Update title and description for your plugin -->
34+
*TODO: Update title and description for your plugin*
3735
3836
Example Formae plugin template - replace this with a description of what your plugin manages.
3937
@@ -46,7 +44,7 @@ make install
4644
4745
## Supported Resources
4846

49-
<!-- TODO: Document your supported resource types -->
47+
*TODO: Document your supported resource types*
5048

5149
| Resource Type | Description |
5250
|---------------|-------------|

0 commit comments

Comments
 (0)