mirror/element-plus
2
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2024-11-21 01:02:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: update README for available scripts

Browse Source
This commit is contained in:
Herrington Darkholme 2020-07-24 20:29:10 +08:00 committed by jeremywu
parent a08302c7c7
commit 76a192730e
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -3,13 +3,22 @@ Element-Plus
## Bootstrap project
With command
```bash
$ yarn bs
$ yarn bootstrap
```
the project will install all dependencies and run `lerna bootstrap` to initialize the project
## Storybook preview
With command
```bash
$ yarn sb
$ yarn storybook
```
the project will launch `@storybook` client for you to preview all existing component
## Generate new component
With command
```bash
$ yarn gen component-name
```
Note the `component-name` must be in `kebab-case`, combining words by replacing each space with a dash.