فهرست منبع

Update README

dufu1991 3 سال پیش
والد
کامیت
8ad64148da
2فایلهای تغییر یافته به همراه52 افزوده شده و 22 حذف شده
  1. 26 11
      README.md
  2. 26 11
      README_CN.md

+ 26 - 11
README.md

@@ -6,6 +6,7 @@
 [![Build Status](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml)
 [![Build Status](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml)
 [![Public Create Status](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml)
 [![Public Create Status](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml)
 [![Public Icon Status](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml)
 [![Public Icon Status](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml)
+[![Public VS Code Extension Status](https://github.com/dufu1991/stdf/actions/workflows/publish-vscode.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-vscode.yml)
 
 
   <picture>
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://stdf.design/assets/favicon_logo_dark/android-chrome-512x512.png">
     <source media="(prefers-color-scheme: dark)" srcset="https://stdf.design/assets/favicon_logo_dark/android-chrome-512x512.png">
@@ -35,18 +36,19 @@ Mobile web component library based on [Svelte](https://svelte.dev) and [Tailwind
 
 
 # Features
 # Features
 
 
-- 🚀 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;
-- 📖 Provides extensive Chinese and English documentation and component examples;
-- 🌍 Supports internationalization, with 60+ built-in language packages;
-- 🫰 User-friendly interaction, animation parameters can be configured, and custom themes are supported;
-- 🤝 Supports Tailwind libraries such as Windi CSS and UnoCSS;
+- 🚀 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.
+- 📖 Provides extensive Chinese and English documentation and component examples.
+- 🌍 Supports internationalization, with 60+ built-in language packages.
+- 🫰 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.
 - 🫡 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.
 - 📦 Supports on-demand import to reduce bundle size.
 - 🪜 Comes with a scaffolding tool for quick project creation.
 - 🪜 Comes with a scaffolding tool for quick project creation.
 - 🔗 Comes with an SVG merging plugin for quickly merging SVG files.
 - 🔗 Comes with an SVG merging plugin for quickly merging SVG files.
+- 🍺 IDE plugin for quickly viewing component APIs.
 
 
 # Getting Started
 # Getting Started
 
 
@@ -96,9 +98,18 @@ Please scan the QR code to access the mobile demo:
   <img src="https://stdf.design/assets/qr/demo_en.png" width="220" height="220" >
   <img src="https://stdf.design/assets/qr/demo_en.png" width="220" height="220" >
 </picture>
 </picture>
 
 
-# License
+# Quick Try
 
 
-This project is licensed under the [MIT License](https://github.com/dufu1991/stdf/blob/main/LICENSE). Feel free to enjoy and contribute to this open-source project.
+You can quickly try STDF on StackBlitz's [STDF Demo](https://stackblitz.com/github/dufu1991/demo-stdf).
+
+# Feedback and Communication
+
+We recommend using [GitHub Issues](https://github.com/dufu1991/stdf/issues) for direct and effective feedback and communication. Contributions of code are also highly appreciated. You can also choose from the following options:
+
+- [QQ Group](https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=U8ZlXJ3KVpTI9oZzs1jBnyWc3gVA0h6Y&authKey=ScWu0nU9g8BqNsC7o2eYkESwgVDVz9vzGNZEb17MrEAay9%2F7bTkXDiLJRIzo2vrg&noverify=0&group_code=581073686)
+- [QQ Discord](https://pd.qq.com/s/fdd8incyr)
+- [Discord](https://discord.gg/mzYCQfgcaM)
+- [Discussions](https://github.com/dufu1991/stdf/discussions)
 
 
 # Contributors
 # Contributors
 
 
@@ -106,7 +117,11 @@ This project is licensed under the [MIT License](https://github.com/dufu1991/std
   <img src="https://contrib.rocks/image?repo=dufu1991/stdf" />
   <img src="https://contrib.rocks/image?repo=dufu1991/stdf" />
 </a>
 </a>
 
 
-## Star History
+# License
+
+This project is licensed under the [MIT License](https://github.com/dufu1991/stdf/blob/main/LICENSE). Feel free to enjoy and contribute to this open-source project.
+
+# Star History
 
 
 <a href="https://github.com/dufu1991/stdf">
 <a href="https://github.com/dufu1991/stdf">
   <picture>
   <picture>

+ 26 - 11
README_CN.md

@@ -6,6 +6,7 @@
 [![Build Status](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml)
 [![Build Status](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml)
 [![Public Create Status](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml)
 [![Public Create Status](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml)
 [![Public Icon Status](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml)
 [![Public Icon Status](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml)
+[![Public VS Code Extension Status](https://github.com/dufu1991/stdf/actions/workflows/publish-vscode.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-vscode.yml)
 
 
   <picture>
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://stdf.design/assets/favicon_logo_dark/android-chrome-512x512.png">
     <source media="(prefers-color-scheme: dark)" srcset="https://stdf.design/assets/favicon_logo_dark/android-chrome-512x512.png">
@@ -37,18 +38,19 @@
 
 
 # 特性
 # 特性
 
 
-- 🚀 无运行时,无虚拟 DOM,线上运行更快
-- 🧰 API 丰富,轻松配置出符合需求的组件样式
-- ✍ 基于 Svelte 和 Tailwind,编码迅速轻松;
-- 🍭 支持暗色模式
-- 📖 提供丰富的中英文文档和组件示例
-- 🌍 支持国际化,已内置 60+ 种语言包
-- 🫰 交互友好,动画参数可配,可自定义主题
-- 🤝 支持 Tailwind 类库,如 Windi CSS、UnoCSS 等
+- 🚀 无运行时,无虚拟 DOM,线上运行更快
+- 🧰 API 丰富,轻松配置出符合需求的组件样式
+- ✍ 基于 Svelte 与 Tailwind,编码迅速轻松。
+- 🍭 支持暗色模式
+- 📖 提供丰富的中英文文档和组件示例
+- 🌍 支持国际化,已内置 60+ 种语言包
+- 🫰 交互友好,动画参数可配,可自定义主题
+- 🤝 支持 Tailwind 类库,如 Windi CSS、UnoCSS 等
 - 🫡 无三方依赖,无需担心三方库版本与安全问题。
 - 🫡 无三方依赖,无需担心三方库版本与安全问题。
 - 📦 支持按需引入,减少打包体积。
 - 📦 支持按需引入,减少打包体积。
 - 🪜 配套脚手架,快速创建工程。
 - 🪜 配套脚手架,快速创建工程。
 - 🔗 配套 SVG 合并插件,快速合并 SVG。
 - 🔗 配套 SVG 合并插件,快速合并 SVG。
+- 🍺 配套 IDE 插件,快速查看组件 API。
 
 
 # 快速上手
 # 快速上手
 
 
@@ -98,9 +100,18 @@ npx create-stdf@latest
   <img src="https://stdf.design/assets/qr/demo_zh.png" width="220" height="220" >
   <img src="https://stdf.design/assets/qr/demo_zh.png" width="220" height="220" >
 </picture>
 </picture>
 
 
-# 开源协议
+# 快速尝试
 
 
-本项目基于 [MIT](https://github.com/dufu1991/stdf/blob/main/LICENSE) 协议,请自由地享受和参与开源。
+可以到 StackBlitz 的 [STDF Demo](https://stackblitz.com/github/dufu1991/demo-stdf) 快速尝试 STDF。
+
+# 反馈与交流
+
+推荐使用 [GitHub Issues](https://github.com/dufu1991/stdf/issues) 进行直接有效地反馈与交流,贡献代码就更好了。也可以选择以下几种方式:
+
+- [QQ 群](https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=U8ZlXJ3KVpTI9oZzs1jBnyWc3gVA0h6Y&authKey=ScWu0nU9g8BqNsC7o2eYkESwgVDVz9vzGNZEb17MrEAay9%2F7bTkXDiLJRIzo2vrg&noverify=0&group_code=581073686)
+- [QQ 频道](https://pd.qq.com/s/fdd8incyr)
+- [Discord](https://discord.gg/mzYCQfgcaM)
+- [Discussions](https://github.com/dufu1991/stdf/discussions)
 
 
 # 贡献者
 # 贡献者
 
 
@@ -108,7 +119,11 @@ npx create-stdf@latest
   <img src="https://contrib.rocks/image?repo=dufu1991/stdf" />
   <img src="https://contrib.rocks/image?repo=dufu1991/stdf" />
 </a>
 </a>
 
 
-## Star 历史
+# 开源协议
+
+本项目基于 [MIT](https://github.com/dufu1991/stdf/blob/main/LICENSE) 协议,请自由地享受和参与开源。
+
+# Star 历史
 
 
 <a href="https://github.com/dufu1991/stdf">
 <a href="https://github.com/dufu1991/stdf">
   <picture>
   <picture>