Skip to content

Commit 494e529

Browse files
committed
docs: add warning not to clone template directly
1 parent c6f04f1 commit 494e529

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@
44
55
## Getting Started
66
7+
> **⚠️ Do not clone this repository directly!**
8+
>
9+
> Use `formae plugin init` to create your plugin. This command scaffolds a new
10+
> plugin from this template with proper naming and configuration.
11+
>
12+
> ```bash
13+
> formae plugin init my-plugin
14+
> ```
15+
716
After creating your plugin with `formae plugin init`, complete these steps:
817
918
- [ ] Update `formae-plugin.pkl` with your plugin metadata (name, namespace, description)

0 commit comments

Comments
 (0)