Skip to content

Commit 48ecc71

Browse files
authored
Merge pull request #7 from robmen/patch-1
Update README.md install instructions
2 parents f82a5fd + e55d37d commit 48ecc71

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,26 @@ An Astro integration that checks for broken links in your website during static
2020

2121
## Installation
2222

23-
Install the package and its peer dependencies:
24-
25-
```bash
26-
npm install astro-broken-links-checker
23+
Install the package and its peer dependencies using a [GitHub reference](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#github-urls) in your `package.json`:
24+
25+
```json
26+
...
27+
"dependencies": {
28+
"astro": "5.1.9",
29+
"astro-broken-link-checker": "imazen/astro-broken-link-checker",
30+
...
2731
```
32+
33+
> [!NOTE]
34+
> In the future, if/when `astro-broken-link-checker` becomes available on NPM:
35+
> ```bash
36+
> npm install astro-broken-link-checker
37+
> ```
38+
39+
Finally, update your `astro.config.mjs`
2840
```js
2941
import { defineConfig } from 'astro/config';
30-
import astroBrokenLinksChecker from 'astro-broken-links-checker';
42+
import astroBrokenLinksChecker from 'astro-broken-link-checker';
3143

3244
export default defineConfig({
3345
// ... other configurations ...
@@ -38,4 +50,4 @@ export default defineConfig({
3850
}),
3951
],
4052
});
41-
```
53+
```

0 commit comments

Comments
 (0)