Skip to content

Commit a77feaf

Browse files
fengmk2claude
andauthored
docs: improve publish instructions and add warning (#428)
* docs: improve publish instructions and add warning - Add bash syntax highlighting for code blocks - Include --tags flag for git push to ensure tags are pushed - Add warning note about not running npm publish manually 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * FIX * FIX --------- Co-authored-by: Claude <[email protected]>
1 parent 954d0f0 commit a77feaf

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
## Install this test package
1515

16-
```
16+
```bash
1717
yarn 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.

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
"version": "1.0.0",
44
"description": "Template project for writing node package with napi-rs",
55
"main": "index.js",
6-
"repository": "[email protected]:napi-rs/package-template.git",
6+
"repository": {
7+
"type": "git",
8+
"url": "git+ssh://[email protected]/napi-rs/package-template.git"
9+
},
710
"license": "MIT",
811
"browser": "browser.js",
912
"keywords": [

0 commit comments

Comments
 (0)