Skip to content

Commit 62280c7

Browse files
authored
fix: package json edit after template init, the actions not working now
1 parent 171b9d2 commit 62280c7

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,23 @@ Create a new repository using this template.
9191
- Clone your GitHub Repo created from `step 2`. See
9292
[this link](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
9393
to lean how to clone a repository from GitHub.
94+
- Edit `package.json` file in template, make sure to update the following fields accordingly:
95+
96+
| Field | Description |
97+
|-------------|------------------------------------------------------------------------|
98+
| `title` | Replace "Name of the extension" with the actual title of your extension. |
99+
| `name` | Change `github-<owner>-<repo>` to your specific package name, formatted as `github-yourusername-reponame`. |
100+
| `description` | Update to a brief, relevant description of what your extension does. |
101+
| `version` | Start with "0.0.1" or update to reflect your current version following semantic versioning. |
102+
| `license` | Confirm "MIT" is suitable or specify another license if necessary. |
103+
| `author` | Replace with your name and a link to your GitHub profile or another URL. |
104+
| `homepage` | Set to the URL of your project’s homepage or GitHub repository. |
105+
| `engines` | Ensure compatibility with the required Brackets version, e.g., ">=3.0.0". |
106+
| `categories`| Update "demo" with relevant categories that fit your extension. |
107+
| `keywords` | Update or append additional keywords that describe your extension. |
108+
| `files` | Ensure this includes all necessary files and folders for your extension. |
109+
110+
94111

95112
## step 4
96113

0 commit comments

Comments
 (0)