@teamias/rex-design 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +31 -9
  2. package/package.json +9 -5
package/README.md CHANGED
@@ -3,11 +3,23 @@
3
3
  [![NPM version](https://img.shields.io/npm/v/@teamias/rex-design.svg?style=flat)](https://npmjs.org/package/@teamias/rex-design)
4
4
  [![NPM downloads](http://img.shields.io/npm/dm/@teamias/rex-design.svg?style=flat)](https://npmjs.org/package/@teamias/rex-design)
5
5
 
6
- A react library developed with dumi
6
+ dumi 开发的 react
7
7
 
8
8
  ## Usage
9
9
 
10
- TODO
10
+ ### 安装组件库
11
+
12
+ ```bash
13
+ # 安装组件库
14
+ $ pnpm add @teamias/rex-design
15
+
16
+ ```
17
+
18
+ ### 代码引用
19
+
20
+ ```ts
21
+ import { ActionButtons } from '@teamias/rex-design';
22
+ ```
11
23
 
12
24
  ## Options
13
25
 
@@ -16,28 +28,38 @@ TODO
16
28
  ## Development
17
29
 
18
30
  ```bash
19
- # install dependencies
31
+ # 安装依赖项
20
32
  $ pnpm install
21
33
 
22
- # develop library by docs demo
34
+ # 通过文档演示开发库
23
35
  $ pnpm start
24
36
 
25
- # build library source code
37
+ # 构建库源代码
26
38
  $ pnpm run build
27
39
 
28
- # build library source code in watch mode
40
+ # 在监视模式下构建库源代码
29
41
  $ pnpm run build:watch
30
42
 
31
- # build docs
43
+ # 生成文档
32
44
  $ pnpm run docs:build
33
45
 
34
- # Locally preview the production build.
46
+ # 本地预览生产构建。
35
47
  $ pnpm run docs:preview
36
48
 
37
- # check your project for potential problems
49
+ # 检查项目的潜在问题
38
50
  $ pnpm run doctor
39
51
  ```
40
52
 
53
+ ## Publish
54
+
55
+ ```bash
56
+ # 首次发包前,进行用户添加
57
+ $ pnpm adduser
58
+
59
+ # 发布新版本
60
+ $ pnpm run deploy
61
+ ```
62
+
41
63
  ## LICENSE
42
64
 
43
65
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teamias/rex-design",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "description": "A react library developed with dumi",
5
5
  "license": "MIT",
6
6
  "module": "dist/index.js",
@@ -12,9 +12,10 @@
12
12
  "adduser": "npm adduser",
13
13
  "build": "father build",
14
14
  "build:watch": "father dev",
15
- "deploy": "pnpm build && changeset && changeset version && pnpm run publish",
15
+ "deploy": "changeset && changeset version && npm publish && npm run docs:deploy",
16
16
  "dev": "dumi dev",
17
17
  "docs:build": "dumi build",
18
+ "docs:deploy": "vercel --prod",
18
19
  "docs:preview": "dumi preview",
19
20
  "doctor": "father doctor",
20
21
  "lint": "npm run lint:es",
@@ -22,8 +23,6 @@
22
23
  "lint:es": "eslint \"{src,test}/**/*.{js,jsx,ts,tsx}\"",
23
24
  "prepare": "husky install && dumi setup",
24
25
  "prepublishOnly": "father doctor && npm run build",
25
- "publish": "npm publish",
26
- "publish:first": "npm publish --access public",
27
26
  "start": "npm run dev"
28
27
  },
29
28
  "commitlint": {
@@ -66,6 +65,7 @@
66
65
  "@changesets/cli": "^2.29.5",
67
66
  "@commitlint/cli": "^17.1.2",
68
67
  "@commitlint/config-conventional": "^17.1.0",
68
+ "@teamias/umi-loader-source-plugin": "^0.0.6",
69
69
  "@types/lodash": "^4.17.20",
70
70
  "@types/react": "^18.0.0",
71
71
  "@types/react-dom": "^18.0.0",
@@ -83,8 +83,12 @@
83
83
  "stylelint": "^14.9.1"
84
84
  },
85
85
  "peerDependencies": {
86
+ "@ant-design/icons": ">=5.0.0",
87
+ "@ant-design/pro-components": ">=2.0.0",
88
+ "antd": ">=5.0.0",
86
89
  "react": ">=16.9.0",
87
- "react-dom": ">=16.9.0"
90
+ "react-dom": ">=16.9.0",
91
+ "react-intl": ">=3.0.0"
88
92
  },
89
93
  "publishConfig": {
90
94
  "access": "public"