Skip to content

Commit 79804ee

Browse files
committed
📚 DOC: update dev docs
1 parent ff4e1c7 commit 79804ee

File tree

3 files changed

+58
-1
lines changed

3 files changed

+58
-1
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@ tmp
99
build
1010

1111
# Dependency directory
12-
node_modules
12+
node_modules
13+
14+
.env

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ src/
1717
rollup.config.js
1818
tsconfig.json
1919
dev.md
20+
.env

dev.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ cd demo-app
99
npm link react-ui-scrollspy
1010
```
1111

12+
creates a `.tgz`
13+
14+
```bash
15+
npm pack
16+
```
17+
1218
## Commit Messages
1319

1420
https://github.com/ahmadawais/Emoji-Log
@@ -22,3 +28,51 @@ git commit -m "🚀 RELEASE: "
2228
git commit -m "🤖 TEST: "
2329
git commit -m "‼️ BREAKING: "
2430
```
31+
32+
### GitHub package
33+
34+
```bash
35+
npm login --registry=https://npm.pkg.github.com/
36+
```
37+
38+
#### package.json
39+
40+
```json
41+
"name": "@pettiboy/react-ui-scrollspy",
42+
.....
43+
"publishConfig": {
44+
"registry": "https://npm.pkg.github.com/"
45+
},
46+
"repository": {
47+
"type": "git",
48+
"url": "git+https://github.com/pettiboy/react-ui-scrollspy.git",
49+
"directory": "react-ui-scrollspy"
50+
},
51+
"bugs".....
52+
```
53+
54+
```bash
55+
npm publish
56+
```
57+
58+
### npm package
59+
60+
```bash
61+
npm login
62+
```
63+
64+
#### package.json
65+
66+
```json
67+
"name": "react-ui-scrollspy",
68+
....
69+
"repository": {
70+
"type": "git",
71+
"url": "git+https://github.com/pettiboy/react-ui-scrollspy.git"
72+
},
73+
"bugs".....
74+
```
75+
76+
```bash
77+
npm publish
78+
```

0 commit comments

Comments
 (0)