Skip to content

Commit 8cbb164

Browse files
Simplify README
Remove repository layout tree, merge getting started sections, fold validation into submission checklist, cut redundancy. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent bf795ee commit 8cbb164

File tree

5 files changed

+12
-72
lines changed

5 files changed

+12
-72
lines changed

.cursor/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
plans/

README.md

Lines changed: 8 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -7,77 +7,21 @@ Two starter plugins are included:
77
- **starter-simple**: rules and skills only
88
- **starter-advanced**: rules, skills, agents, commands, hooks, MCP, and scripts
99

10-
## Repository layout
10+
## Getting started
1111

12-
```text
13-
.
14-
├── .cursor-plugin/
15-
│ └── marketplace.json
16-
├── plugins/
17-
│ ├── starter-simple/
18-
│ │ ├── .cursor-plugin/plugin.json
19-
│ │ ├── rules/
20-
│ │ ├── skills/
21-
│ │ └── assets/
22-
│ └── starter-advanced/
23-
│ ├── .cursor-plugin/plugin.json
24-
│ ├── rules/
25-
│ ├── skills/
26-
│ ├── agents/
27-
│ ├── commands/
28-
│ ├── hooks/
29-
│ ├── mcp.json
30-
│ ├── scripts/
31-
│ └── assets/
32-
├── docs/add-a-plugin.md
33-
└── scripts/validate-template.mjs
34-
```
12+
[Use this template](https://github.com/cursor/plugin-template/generate) to create a new repository, then customize:
3513

36-
## Use this template
14+
1. `.cursor-plugin/marketplace.json`: set marketplace `name`, `owner`, and `metadata`.
15+
2. `plugins/*/.cursor-plugin/plugin.json`: set `name` (lowercase kebab-case), `displayName`, `author`, `description`, `keywords`, `license`, and `version`.
16+
3. Replace placeholder rules, skills, agents, commands, hooks, scripts, and logos.
3717

38-
1. Click **Use this template** > **Create a new repository** on GitHub.
39-
2. Choose owner, repo name, and visibility.
40-
3. Create the repository. Default branch only is recommended.
41-
4. Clone and customize.
42-
43-
## Quick customization
44-
45-
Update these files first:
46-
47-
1. `.cursor-plugin/marketplace.json`
48-
- Set marketplace `name`, `owner`, and `metadata`.
49-
- `metadata.pluginRoot` is optional. Remove it if plugin `source` paths are explicit.
50-
2. `plugins/*/.cursor-plugin/plugin.json`
51-
- Rename `name` to a unique lowercase kebab-case value.
52-
- Replace `author`, `description`, `keywords`, `license`, and `version`.
53-
- Keep logo paths relative (e.g. `assets/logo.svg`).
54-
3. Replace placeholder content:
55-
- `plugins/*/assets/logo.svg`
56-
- Rules, skills, agents, commands, hooks, and scripts
18+
To add more plugins, see `docs/add-a-plugin.md`.
5719

5820
## Single plugin vs multi-plugin
5921

60-
Use **multi-plugin** (current setup) when one repository publishes several related plugins.
61-
62-
For a **single plugin**:
63-
64-
1. Move your plugin folder contents to the repository root.
65-
2. Keep one `.cursor-plugin/plugin.json` at the root plugin directory.
66-
3. Remove `.cursor-plugin/marketplace.json`.
67-
4. Update all component paths accordingly.
68-
69-
## Local validation
22+
This template defaults to **multi-plugin** (multiple plugins in one repo).
7023

71-
```bash
72-
node scripts/validate-template.mjs
73-
```
74-
75-
This checks:
76-
77-
- Marketplace and plugin manifest presence
78-
- Plugin naming format (kebab-case)
79-
- Referenced file paths in manifests
80-
- Frontmatter metadata on rules, skills, agents, and commands
24+
For a **single plugin**, move your plugin folder contents to the repository root, keep one `.cursor-plugin/plugin.json`, and remove `.cursor-plugin/marketplace.json`.
8125

8226
## Submission checklist
8327

@@ -87,12 +31,4 @@ This checks:
8731
- All frontmatter metadata is present in rule, skill, agent, and command files.
8832
- Logos are committed and referenced with relative paths.
8933
- `node scripts/validate-template.mjs` passes.
90-
- README and plugin docs describe behavior and required configuration.
9134
- Repository link is ready for submission to the Cursor team (Slack or `kniparko@anysphere.com`).
92-
93-
## Next steps
94-
95-
- Add or remove plugin folders under `plugins/`.
96-
- Follow `docs/add-a-plugin.md` for adding a new plugin entry.
97-
98-
**Create a new repo from this template:** [Use this template](https://github.com/cursor/plugin-template/generate) or click **Use this template** on the repo page.

docs/add-a-plugin.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Example manifest:
2121
```json
2222
{
2323
"name": "my-new-plugin",
24+
"displayName": "My New Plugin",
2425
"version": "0.1.0",
2526
"description": "Describe what this plugin does",
2627
"author": {

plugins/starter-advanced/.cursor-plugin/plugin.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"name": "starter-advanced",
3+
"displayName": "Advanced Starter",
34
"version": "0.1.0",
45
"description": "Full-featured Cursor plugin starter with rules, skills, agents, commands, hooks, and MCP.",
56
"author": {

plugins/starter-simple/.cursor-plugin/plugin.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"name": "starter-simple",
3+
"displayName": "Simple Starter",
34
"version": "0.1.0",
45
"description": "Minimal Cursor plugin starter with rules and skills.",
56
"author": {

0 commit comments

Comments
 (0)