From 76a192730ed153d72def542f798dc0b934faa13c Mon Sep 17 00:00:00 2001 From: Herrington Darkholme <2883231+HerringtonDarkholme@users.noreply.github.com> Date: Fri, 24 Jul 2020 20:29:10 +0800 Subject: [PATCH] doc: update README for available scripts --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 196ed84744..ab56eb894e 100644 --- a/README.md +++ b/README.md @@ -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.