Skip to content

Commit 89c96f3

Browse files
danbot315Daniel Clayton
andauthored
docs: attach README + repo metadata to published npm packages (#19)
* docs: include package READMEs and npm metadata links for core/cli * chore: add changeset for npm package readme/metadata links --------- Co-authored-by: Daniel Clayton <dan@Daniels-Mac-mini.local>
1 parent b90f4b9 commit 89c96f3

5 files changed

Lines changed: 54 additions & 0 deletions

File tree

.changeset/khaki-radios-kick.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@dotgithub/core": patch
3+
"@dotgithub/cli": patch
4+
---
5+
6+
Add package-level README files and npm metadata links (homepage/repository/bugs) so published packages point back to project documentation.

packages/cli/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# @dotgithub/cli
2+
3+
CLI for DotGitHub workflow scaffolding and synthesis.
4+
5+
## Install
6+
7+
```bash
8+
npm install -g @dotgithub/cli
9+
# or
10+
npx @dotgithub/cli --help
11+
```
12+
13+
## Docs
14+
15+
- <https://github.com/azwebmaster/dotgithub#readme>
16+
- <https://github.com/azwebmaster/dotgithub/tree/main/docs>

packages/cli/package.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,14 @@
2222
"publishConfig": {
2323
"registry": "https://registry.npmjs.org",
2424
"access": "public"
25+
},
26+
"homepage": "https://github.com/azwebmaster/dotgithub#readme",
27+
"repository": {
28+
"type": "git",
29+
"url": "https://github.com/azwebmaster/dotgithub.git",
30+
"directory": "packages/cli"
31+
},
32+
"bugs": {
33+
"url": "https://github.com/azwebmaster/dotgithub/issues"
2534
}
2635
}

packages/core/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# @dotgithub/core
2+
3+
Core library for DotGitHub: type-safe constructs and workflow generation utilities.
4+
5+
## Install
6+
7+
```bash
8+
npm install @dotgithub/core
9+
```
10+
11+
## Docs
12+
13+
- <https://github.com/azwebmaster/dotgithub#readme>
14+
- <https://github.com/azwebmaster/dotgithub/tree/main/docs>

packages/core/package.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,14 @@
3333
"prettier"
3434
]
3535
}
36+
},
37+
"homepage": "https://github.com/azwebmaster/dotgithub#readme",
38+
"repository": {
39+
"type": "git",
40+
"url": "https://github.com/azwebmaster/dotgithub.git",
41+
"directory": "packages/core"
42+
},
43+
"bugs": {
44+
"url": "https://github.com/azwebmaster/dotgithub/issues"
3645
}
3746
}

0 commit comments

Comments
 (0)