Skip to content

Commit 4b6f2e9

Browse files
authored
docs: fix pnpm rename command and align with yarn template (#173)
- use `pnpm napi` instead of `npx napi` - add bash language Identifier to code blocks - sync warning note from yarn template
1 parent df7a0cc commit 4b6f2e9

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99
1. Click **Use this template**.
1010
2. **Clone** your project.
1111
3. Run `pnpm install` to install dependencies.
12-
4. Run `npx napi rename -n [name]` command under the project folder to rename your package.
12+
4. Run `pnpm napi rename -n [@your-scope/package-name] -b [binary-name]` command under the project folder to rename your package.
1313

1414
## Install this test package
1515

16-
```
16+
```bash
1717
pnpm add @napi-rs/package-template
1818
```
1919

@@ -76,10 +76,12 @@ In `Settings -> Secrets`, add **NPM_TOKEN** into it.
7676

7777
When you want to release the package:
7878

79-
```
79+
```bash
8080
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
8181

8282
git push
8383
```
8484

8585
GitHub actions will do the rest job for you.
86+
87+
> WARN: Don't run `npm publish` manually.

0 commit comments

Comments
 (0)