Skip to content

Commit aef6107

Browse files
committed
Update readme
1 parent 5e1062d commit aef6107

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@ A website to visualize the web platform reference pages that's maintained by Ope
66

77
### Data
88

9-
The data that the website is based on comes from the [web-features](https://www.npmjs.com/package/web-features) npm package, by using its **next** version (which always provide the data from the latest commit on the web-features repo).
10-
11-
In addition, the [@mdn/browser-compat-data](https://www.npmjs.com/package/browser-compat-data) npm package is used to get various other pieces of information, such as links to MDN documentation and links to bug trackers.
9+
The data that the website is based on comes from the [@mdn/browser-compat-data](https://www.npmjs.com/package/browser-compat-data) npm package
1210

1311
To ensure you have the latest data:
1412

1513
1. Run `npx npm-check-updates -u`
1614

17-
1. Run `npm update web-features`
15+
1. Run `npm updat e@mdn/browser-compat-data`
1816

1917
### Build
2018

@@ -29,8 +27,8 @@ To re-generate the website, after updating the data:
2927
1. Run `npm install`
3028

3129
1. Run `npm run build` to generate the site
32-
33-
You can also run `npm run serve` to start a local server and watch for changes
30+
31+
You can also run `npx eleventy --serve` to start a local server and watch for changes
3432

3533
### Deployment
3634

@@ -42,4 +40,4 @@ The static HTML pages are generated on the [gh-pages branch](https://github.com/
4240

4341
The website is automatically updated on every push to the main branch by using a GitHub Actions script found in `.github/workflows/generate-site.yaml`.
4442

45-
The dependencies are also automatically updated every day by using the GitHub Actions script in `.github/workflows/bump-deps.yaml`.
43+
The dependencies are also automatically updated everyday by dependabot.

0 commit comments

Comments
 (0)