neko-ui 2.0.0 → 2.0.1

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 +17 -27
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,15 +1,17 @@
1
1
  # Neko UI
2
2
 
3
- > UI组件库
4
-
5
3
  [![version][version-tag]][npm-url]
6
4
  [![install size][size-tag]][size-url]
7
5
  [![download][download-tag]][npm-url]
8
6
 
9
- ## 使用
7
+ > 这是一个适用于任何技术栈的 WebComponents UI组件库
10
8
 
11
9
  [![neko-ui][install-tag]][npm-url]
12
10
 
11
+ [![docs-ui][docs-tag]][docs-url]
12
+
13
+ [docs-url]: https://monako97.github.io/neko-ui
14
+ [docs-tag]: https://cdn.staticaly.com/gh/monako97/cdn/main/image/202307281701250.svg
13
15
  [npm-url]: https://npmjs.org/package/neko-ui
14
16
  [install-tag]: https://nodei.co/npm/neko-ui.png
15
17
  [version-tag]: https://img.shields.io/npm/v/neko-ui/latest.svg?logo=npm
@@ -17,40 +19,28 @@
17
19
  [size-url]: https://packagephobia.com/result?p=neko-ui@latest
18
20
  [download-tag]: https://img.shields.io/npm/dm/neko-ui.svg?logo=docusign
19
21
 
20
- > 这是一个适用于任何技术栈的 WebComponents 组件库
21
-
22
- ## 安装依赖
22
+ ## 安装 (npm)
23
23
 
24
24
  ```shell
25
- npm install
25
+ npm install neko-ui -S
26
26
  # or
27
- yarn install
27
+ yarn add neko-ui -S
28
28
  ```
29
29
 
30
- ## 启动项目
30
+ ### 使用 (npm)
31
31
 
32
- ```shell
33
- npm start
34
- # or
35
- yarn start
32
+ ```html
33
+ <n-button>按钮</n-button>
36
34
  ```
37
35
 
38
- ## 打包项目
36
+ ## 安装 (umd)
39
37
 
40
- ```shell
41
- npm run build
42
- # or
43
- yarn build
38
+ ```html
39
+ <script src="https://cdn.staticaly.com/gh/monako97/cdn/main/npm/neko-ui/2.0.1/lib/index.js"></script>
44
40
  ```
45
41
 
46
- ## 打包项目`使用自定义配置`
47
-
48
- > 在打包其它有特殊配置的bundle时, 可以通过命令行参数来加载额外的配置文件;
49
-
50
- 例如: 使用 **config/index.ts** 与 **config/prod.ts** 合并后的配置进行编译.
42
+ ### 使用 (umd)
51
43
 
52
- ```shell
53
- npm run build --config=prod
54
- # or
55
- yarn build config=prod
44
+ ```html
45
+ <n-button>按钮</n-button>
56
46
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "neko-ui",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "Web Components UI Libraries",
5
5
  "main": "lib/index.js",
6
6
  "scripts": {