From aac60900687244064abc266a5b024df7905ae8a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=84=9A=E9=81=93?= Date: Fri, 8 Mar 2019 10:49:46 +0800 Subject: [PATCH] doc: add block dev doc --- README.md | 18 +++++++++++------- package.json | 1 + 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 718927b8..39116ac4 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,26 @@ -# umi-blocks +# pro-blocks -Official collection of some high quality blocks. +umi blocks of Ant Design Pro. ## Usage ```shell -$ umi block list -$ umi block add [A block name in list, or any github address of a umi block] +$ umi block add [the github url of block] ``` You can visit umi [doc](https://umijs.org/guide/block.html) for find out more info about umi block. ## Contribute -You can create a umi block and make a PR for us! +```shell +$ cd [some block] +$ yarn # or npm install +$ yarn run dev # or npm run dev +``` -How to create a block: +Or ```shell -$ yarn create umi --block +$ yarn # or npm install +$ APP_ROOT=[some block] yarn run dev # or APP_ROOT=[someblock] npm run dev ``` diff --git a/package.json b/package.json index 8af2d3bd..c016cb78 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,7 @@ { "private": true, "scripts": { + "dev": "umi dev", "lint:style": "stylelint \"src/**/*.less\" --syntax less", "lint": "eslint --ext .js src mock tests && npm run lint:style", "lint:fix": "eslint --fix --ext .js src mock tests && npm run lint:style", -- GitLab