Skip to content

Commit de33e87

Browse files
bennypowersweb-padawan
authored andcommitted
docs: update README
1 parent 38f1445 commit de33e87

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# <api-viewer>
22

3-
API documentation and live playground for Web Components. Based on [web-component-analyzer](https://github.com/runem/web-component-analyzer) JSON format.
3+
API documentation and live playground for Web Components. Based on [custom elements manifest](https://github.com/webcomponents/custom-elements-manifest) JSON format.
44

55
```html
66
<api-viewer src="./custom-elements.json"></api-viewer>
@@ -42,18 +42,20 @@ Or grab from [unpkg.com CDN](https://unpkg.com/api-viewer-element?module):
4242

4343
## Usage
4444

45-
1. Install [web-component-analyzer](https://github.com/runem/web-component-analyzer):
45+
1. Install [custom elements manifest analyzer](https://github.com/open-wc/custom-elements-manifest):
4646

4747
```sh
48-
$ npm install -g web-component-analyzer
48+
$ npm install @custom-elements-manifest/analyzer
4949
```
5050

51-
2. Analyze your components using `--format json`:
51+
2. Analyze your components:
5252

5353
```sh
54-
$ wca analyze my-element.js --outFile custom-elements.json --format json
54+
$ cem analyze my-element.js
5555
```
5656

57+
Read the [docs](https://custom-elements-manifest.open-wc.org) for more information on how to use the analyzer.
58+
5759
3. Create an HTML file and import the component:
5860

5961
```html
@@ -374,7 +376,7 @@ npm run serve:dist
374376

375377
## Acknowledgements
376378

377-
- Big thanks to [@runem](http://github.com/runem) for creating Web Component Analyzer.
379+
- Big thanks to [@runem](http://github.com/runem) for creating Web Component Analyzer, which previous versions of this package were based on.
378380
- Thanks to [@bahrus](https://github.com/bahrus) for [wc-info](https://github.com/bahrus/wc-info) component which inspired me.
379381
- The visual appearance is largely inspired by [Vuetify](https://vuetifyjs.com/en/getting-started/quick-start) API docs.
380382
- The tabs component is based on the [howto-tabs](https://developers.google.com/web/fundamentals/web-components/examples/howto-tabs) example.

0 commit comments

Comments
 (0)