dufu1991 1 жил өмнө
parent
commit
569b744a6b
2 өөрчлөгдсөн 47 нэмэгдсэн , 80 устгасан
  1. 23 39
      README.md
  2. 24 41
      README_CN.md

+ 23 - 39
README.md

@@ -26,9 +26,9 @@
 [![Visual Studio Marketplace Version (including pre-releases)](https://img.shields.io/visual-studio-marketplace/v/STDF.stdf-vscode-extension?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMDAiIGhlaWdodD0iMjAwIiB2aWV3Qm94PSIwIDAgMzIgMzIiPgogICAgPHBhdGgKICAgICAgICBmaWxsPSIjRjBGQ0Q2IgogICAgICAgIGQ9Ik0zMC44NjUgMy40NDhMMjQuMjgyLjI4MWExLjk5IDEuOTkgMCAwIDAtMi4yNzYuMzg1TDkuMzk3IDEyLjE3MUwzLjkwMiA4LjAwNGExLjMzIDEuMzMgMCAwIDAtMS43MDMuMDczTC40MzkgOS42ODFhMS4zMyAxLjMzIDAgMCAwLS4wMDUgMS45NjlMNS4yIDE1Ljk5OUwuNDM0IDIwLjM0OGExLjMzIDEuMzMgMCAwIDAgLjAwNSAxLjk2OWwxLjc2IDEuNjA0YTEuMzMgMS4zMyAwIDAgMCAxLjcwMy4wNzNsNS40OTUtNC4xNzJsMTIuNjE1IDExLjUxYTEuOTgyIDEuOTgyIDAgMCAwIDIuMjcxLjM4NWw2LjU4OS0zLjE3MmExLjk5MyAxLjk5MyAwIDAgMCAxLjEzLTEuODAyVjUuMjQ4YzAtLjc2Ni0uNDQzLTEuNDY5LTEuMTM1LTEuODAyem0tNi44NiAxOS44MThMMTQuNDMyIDE2bDkuNTczLTcuMjY2eiIKICAgIC8+Cjwvc3ZnPgo=&label=extension&style=for-the-badge&color=c7f292&logoColor=F0FCD6&labelColor=0E1901)](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension)
 
   <h3>
-    <a href="https://github.com/any-tdf/stdf/blob/next/README_CN.md" target="_blank">简体中文</a>
+    <a href="https://github.com/any-tdf/stdf/blob/main/README_CN.md" target="_blank">简体中文</a>
     <span> • </span>
-    <a href="https://next.stdf.design?lang=en_US" target="_blank">Website</a>
+    <a href="https://stdf.design?lang=en_US" target="_blank">Website</a>
   </h3>
 </div>
 
@@ -40,9 +40,9 @@ Mobile web component library based on [Svelte](https://svelte.dev) and [Tailwind
 
 # Features
 
+- 🔥 Full support for Svelte v5, Tailwind CSS v4, and TypeScript.
 - 🚀 No runtime, no virtual DOM, runs faster online.
 - 🧰 Rich API, easily configure component styles that meet your needs.
-- ✍ Based on Svelte and Tailwind, coding is quick and easy.
 - 🍭 Supports dark mode and multiple theme configuration.
 - 📖 Provides extensive Chinese and English documentation and component examples.
 - 🌍 Supports internationalization, with 60+ built-in language packages.
@@ -53,52 +53,36 @@ Mobile web component library based on [Svelte](https://svelte.dev) and [Tailwind
 - 🪜 Comes with a scaffolding tool for quick project creation.
 - 🔗 Comes with an SVG merging plugin for quickly merging SVG files.
 - 🍺 IDE plugin for quickly viewing component APIs.
-- 🔧 Supports TypeScript, with complete type prompts for component Props.
 
 # Getting Started
 
-## Installation
-
-If you have a project configured with Svelte and Tailwind, install directly.
-
+<!-- :::code-groups -->
+<!-- pnpm -->
 ```sh
-pnpm i stdf@next -D
-# or
-npm i stdf@next -D
-# or
-bun i stdf@next -D
-```
-
-## Usage
-
-```xml
-<!-- Button Demo -->
-<script>
-import { Button } from 'stdf';
-</script>
-
-<Button>Default</Button>
+pnpm create stdf
 ```
-
-## 😓 No project? Create one
-
-You can try using [create-stdf](https://www.npmjs.com/package/create-stdf) to quickly create a project.
-
+<!-- :: -->
+<!-- npm -->
 ```sh
-pnpm create stdf
-# or
-npm create stdf@latest
-# or
-npm init stdf@latest
+npm create stdf
 # or
-npx create-stdf@latest
+npm init stdf
 # or
+npx create-stdf
+```
+<!-- :: -->
+<!-- bun -->
+```sh
 bun create stdf
 ```
+<!-- :: -->
+<!-- yarn -->
+```sh
+yarn create stdf
+```
+<!-- ::: -->
 
-Alternatively, you can create a Vite project and configure it to use Tailwind CSS and the configurations used by STDF. Refer to [Vite](https://vitejs.dev/guide/#scaffolding-your-first-vite-project) & [Tailwind CSS](https://tailwindcss.com/docs/guides/vite#svelte) & [STDF](https://stdf.design/#/guide) for more information.
-
-# Preview
+# Preview Demo
 
 Please scan the QR code to access the mobile demo:
 
@@ -109,7 +93,7 @@ Please scan the QR code to access the mobile demo:
 
 # Quick Try
 
-You can quickly try STDF on StackBlitz's [STDF Demo](https://stackblitz.com/github/any-tdf/next-demo-stdf?startScript=dev_en).
+You can quickly try STDF on StackBlitz's [STDF Demo](https://stackblitz.com/github/any-tdf/demo-stdf?startScript=dev_en).
 
 # Feedback and Communication
 

+ 24 - 41
README_CN.md

@@ -26,9 +26,9 @@
 [![Visual Studio Marketplace Version (including pre-releases)](https://img.shields.io/visual-studio-marketplace/v/STDF.stdf-vscode-extension?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMDAiIGhlaWdodD0iMjAwIiB2aWV3Qm94PSIwIDAgMzIgMzIiPgogICAgPHBhdGgKICAgICAgICBmaWxsPSIjRjBGQ0Q2IgogICAgICAgIGQ9Ik0zMC44NjUgMy40NDhMMjQuMjgyLjI4MWExLjk5IDEuOTkgMCAwIDAtMi4yNzYuMzg1TDkuMzk3IDEyLjE3MUwzLjkwMiA4LjAwNGExLjMzIDEuMzMgMCAwIDAtMS43MDMuMDczTC40MzkgOS42ODFhMS4zMyAxLjMzIDAgMCAwLS4wMDUgMS45NjlMNS4yIDE1Ljk5OUwuNDM0IDIwLjM0OGExLjMzIDEuMzMgMCAwIDAgLjAwNSAxLjk2OWwxLjc2IDEuNjA0YTEuMzMgMS4zMyAwIDAgMCAxLjcwMy4wNzNsNS40OTUtNC4xNzJsMTIuNjE1IDExLjUxYTEuOTgyIDEuOTgyIDAgMCAwIDIuMjcxLjM4NWw2LjU4OS0zLjE3MmExLjk5MyAxLjk5MyAwIDAgMCAxLjEzLTEuODAyVjUuMjQ4YzAtLjc2Ni0uNDQzLTEuNDY5LTEuMTM1LTEuODAyem0tNi44NiAxOS44MThMMTQuNDMyIDE2bDkuNTczLTcuMjY2eiIKICAgIC8+Cjwvc3ZnPgo=&label=extension&style=for-the-badge&color=c7f292&logoColor=F0FCD6&labelColor=0E1901)](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension)
 
   <h3>
-    <a href="https://github.com/any-tdf/stdf/blob/next/README.md" target="_blank">English</a>
+    <a href="https://github.com/any-tdf/stdf/blob/main/README.md" target="_blank">English</a>
     <span> • </span>
-    <a href="https://next.stdf.design?lang=zh_CN" target="_blank">网站</a>
+    <a href="https://stdf.design?lang=zh_CN" target="_blank">网站</a>
   </h3>
 </div>
 
@@ -37,14 +37,13 @@
 基于 [Svelte](https://svelte.dev) 与 [Tailwind](https://www.tailwindcss.com) 的移动 web 组件库。
 
 > **S**imple • **T**hin • **D**esign • **F**ast
-
 > 简 单 • 轻 量 • 设 计 • 快 速
 
 # 特性
 
+- 🔥 完整支持 Svelte v5、Tailwind CSS v4 与 TypeScript。
 - 🚀 无运行时,无虚拟 DOM,线上运行更快。
 - 🧰 API 丰富,轻松配置出符合需求的组件样式。
-- ✍ 基于 Svelte 与 Tailwind,编码迅速轻松。
 - 🍭 支持暗模式与多主题配置。
 - 📖 提供丰富的中英文文档和组件示例。
 - 🌍 支持国际化,已内置 60+ 种语言包。
@@ -55,52 +54,36 @@
 - 🪜 配套脚手架,快速创建工程。
 - 🔗 配套 SVG 合并插件,快速合并 SVG。
 - 🍺 配套 IDE 插件,快速查看组件 API。
-- 🔧 支持 TypeScript,组件 Props 有完整的类型提示。
 
 # 快速上手
 
-## 安装
-
-已有配置好 Svelte 与 Tailwind 的工程,直接安装。
-
+<!-- :::code-groups -->
+<!-- pnpm -->
 ```sh
-pnpm i stdf@next -D
-# or
-npm i stdf@next -D
-# or
-bun i stdf@next -D
+pnpm create stdf
 ```
-
-## 使用
-
-```xml
-<!-- Button Demo -->
-<script>
-import { Button } from 'stdf';
-</script>
-
-<Button>默认</Button>
+<!-- :: -->
+<!-- npm -->
+```sh
+npm create stdf
+# 或
+npm init stdf
+# 或
+npx create-stdf
 ```
-
-## 😓 无工程?创建工程
-
-可以尝试使用 [create-stdf](https://www.npmjs.com/package/create-stdf) 快速创建工程。
-
+<!-- :: -->
+<!-- bun -->
 ```sh
-pnpm create stdf
-# or
-npm create stdf@latest
-# or
-npm init stdf@latest
-# or
-npx create-stdf@latest
-# or
 bun create stdf
 ```
+<!-- :: -->
+<!-- yarn -->
+```sh
+yarn create stdf
+```
+<!-- ::: -->
 
-或者自行创建 Vite 工程,并配置 Tailwind CSS 和 STDF 使用到的配置。参考 [Vite](https://cn.vitejs.dev/guide/#scaffolding-your-first-vite-project) & [Tailwind CSS](https://tailwindcss.com/docs/guides/vite#svelte) & [STDF](https://stdf.design/#/guide)。
-
-# 预览
+# 预览 Demo
 
 扫描二维码访问移动端 Demo:
 
@@ -111,7 +94,7 @@ bun create stdf
 
 # 快速尝试
 
-可以到 StackBlitz 的 [STDF Demo](https://stackblitz.com/github/any-tdf/next-demo-stdf) 快速尝试 STDF。
+可以到 StackBlitz 的 [STDF Demo](https://stackblitz.com/github/any-tdf/demo-stdf) 快速尝试 STDF。
 
 # 反馈与交流