Ver código fonte

Update README

dufu1991 3 anos atrás
pai
commit
5286b7beda
2 arquivos alterados com 12 adições e 6 exclusões
  1. 6 3
      README.md
  2. 6 3
      README_CN.md

+ 6 - 3
README.md

@@ -44,6 +44,9 @@ Mobile web component library based on [Svelte](https://svelte.dev) and [Tailwind
 - 🫰 User-friendly interaction, animation parameters can be configured, and custom themes are supported;
 - 🤝 Supports Tailwind libraries such as Windi CSS and UnoCSS;
 - 🫡 No three -party dependence, no need to worry about the three -party library version and security issues.
+- 📦 Supports on-demand import to reduce bundle size.
+- 🪜 Comes with a scaffolding tool for quick project creation.
+- 🔗 Comes with an SVG merging plugin for quickly merging SVG files.
 
 # Getting Started
 
@@ -52,9 +55,9 @@ Mobile web component library based on [Svelte](https://svelte.dev) and [Tailwind
 If you have a project configured with Svelte and Tailwind, install directly.
 
 ```bash
-npm i stdf -D
-# or
 pnpm i stdf -D
+# or
+npm i stdf -D
 ```
 
 ## Usage
@@ -70,7 +73,7 @@ import { Button } from 'stdf';
 
 ## 😓 No project? Create one
 
-You can try using [create-stdf](https://www.npmjs.com/package/create-stdf) to quickly create a project. (beta version, may have issues)
+You can try using [create-stdf](https://www.npmjs.com/package/create-stdf) to quickly create a project. (beta version)
 
 ```bash
 pnpm create stdf

+ 6 - 3
README_CN.md

@@ -46,6 +46,9 @@
 - 🫰 交互友好,动画参数可配,可自定义主题;
 - 🤝 支持 Tailwind 类库,如 Windi CSS、UnoCSS 等;
 - 🫡 无三方依赖,无需担心三方库版本与安全问题。
+- 📦 支持按需引入,减少打包体积。
+- 🪜 配套脚手架,快速创建工程。
+- 🔗 配套 SVG 合并插件,快速合并 SVG。
 
 # 快速上手
 
@@ -54,9 +57,9 @@
 已有配置好 Svelte 与 Tailwind 的工程,直接安装。
 
 ```bash
-npm i stdf -D
-# or
 pnpm i stdf -D
+# or
+npm i stdf -D
 ```
 
 ## 使用
@@ -72,7 +75,7 @@ import { Button } from 'stdf';
 
 ## 😓 无工程?创建工程
 
-可以尝试使用 [create-stdf](https://www.npmjs.com/package/create-stdf) 快速创建工程。(beta 版本,可能存在问题
+可以尝试使用 [create-stdf](https://www.npmjs.com/package/create-stdf) 快速创建工程。(beta 版本)
 
 ```bash
 pnpm create stdf