Skip to content

Commit 58a3932

Browse files
committed
doc: explain about storybook, element generator
1 parent 3d9011d commit 58a3932

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,37 @@ Web Components for Arduino and various electronic parts.
66

77
Check out [the component catalog](https://elements.wokwi.com).
88

9+
## Local development
10+
11+
To prepare for local development, clone this repo, and then install
12+
the dependencies:
13+
14+
```
15+
npm install
16+
```
17+
18+
Then start storybook:
19+
20+
```
21+
npm run storybook
22+
```
23+
24+
This will open a local dev server at http://localhost:6006, where you
25+
can interact with the elements and see your changes live, similar to
26+
[https://elements.wokwi.com].
27+
28+
## Creating a new element
29+
30+
The easiest way to create a new element is to run the generator:
31+
32+
```
33+
npm run new-element --name my-element
34+
```
35+
36+
This will generate a new element called `my-element`. It will also
37+
create a storybook file, so you will be able to see the new element
38+
in storybook (see the "Local development" section above).
39+
40+
## License
41+
42+
Wokwi Elements are released under the [MIT license](LICENSE).

0 commit comments

Comments
 (0)