Skip to content

Commit 9090d58

Browse files
committed
docs: add Using Wokwi Elements section
1 parent 3ca6a1d commit 9090d58

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,22 @@ Check out [the component catalog](https://elements.wokwi.com).
99

1010
Note: these elements only provide the presentation and display of the represented hardware. They do not provide the functional simulation code of the hardware. That is dependant on the application (simulator) that you wish to use these with, and thus up to you to create.
1111

12+
## Using Wokwi Elements
13+
14+
You can install the package with `npm` and then import it into your code:
15+
16+
```js
17+
import '@wokwi/elements';
18+
```
19+
20+
Alternatively, you can load the Wokwi Elements bundle from unpkg's CDN:
21+
22+
```html
23+
<script src="https://unpkg.com/@wokwi/[email protected]/dist/wokwi-elements.bundle.js"></script>
24+
```
25+
26+
Replace 0.48.3 with the latest version number. You can find a list of all the versions in the [releases](https://github.com/wokwi/wokwi-elements/) page.
27+
1228
## Local development
1329

1430
To prepare for local development, clone this repo, and then install

0 commit comments

Comments
 (0)