Skip to content

Commit 34eda00

Browse files
fergusbissetclaude
andcommitted
docs: Add GitHub Packages installation instructions to README
Added alternative installation method via GitHub Packages for users who need access before the npm public registry package is available. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 522209a commit 34eda00

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,30 @@ The NHS FDP Design System provides a complete set of reusable components, design
88

99
## Installation
1010

11+
### From npm (public registry)
12+
13+
```bash
14+
npm install @nhsdigital/fdp-design-system
15+
```
16+
17+
### From GitHub Packages
18+
19+
If the npm package is not yet available, you can install from GitHub Packages:
20+
21+
1. Create or edit `.npmrc` in your project root:
22+
23+
```
24+
@nhsdigital:registry=https://npm.pkg.github.com
25+
```
26+
27+
2. Authenticate with GitHub Packages (requires a GitHub PAT with `read:packages` scope):
28+
29+
```bash
30+
npm login --registry=https://npm.pkg.github.com
31+
```
32+
33+
3. Install the package:
34+
1135
```bash
1236
npm install @nhsdigital/fdp-design-system
1337
```

0 commit comments

Comments
 (0)