杜府 3 лет назад
Родитель
Сommit
ebc0d66305
4 измененных файлов с 141 добавлено и 4 удалено
  1. 70 2
      README.md
  2. 69 0
      README_en.md
  3. 1 1
      doc/guide/quickStart.md
  4. 1 1
      doc/guide/quickStart_en.md

+ 70 - 2
README.md

@@ -1,2 +1,70 @@
-# stdf
-Mobile Web component library based on Svelte and Tailwind
+<div align="center">
+
+  <img src="https://stdf.design/assets/images/stdf_512px.png" alt="logo" width="100" height="auto" />
+  <h1>S T D F</h1>
+
+[![npm (tag)](https://img.shields.io/npm/v/stdf)](https://www.npmjs.com/package/stdf) [![npm](https://img.shields.io/npm/dw/stdf)](https://www.npmjs.com/package/stdf)
+
+  <h4>
+    <a href="https://github.com/dufu1991/stdf/blob/main/README_en.md" target="_blank">English Doc</a>
+  <span> · </span>
+    <a href="https://stdf.design?lang=zh_CN" target="_blank">中文网站</a>
+  <span> · </span>
+    <a href="https://stdf.design?lang=en_US" target="_blank">英文网站</a>
+  </h4>
+</div>
+
+# 介绍
+
+基于 Svelte 与 Tailwind 的移动 web 组件库。
+
+Simple - 简单、Thin - 轻量、Design - 设计、Fast - 快速
+
+# 特性
+
+-   🚀 无运行时,无虚拟 DOM,线上运行更快;
+-   🧰 API 丰富,轻松配置出符合需求的组件样式;
+-   🍭 支持暗色模式;
+-   📖 提供丰富的中英文文档和组件示例;
+-   🌍 支持国际化,已内置 60+ 种语言包;
+-   ✍ 基于 Svelte 和 Tailwind,编码迅速轻松;
+-   🫰 交互友好,动画参数可配,可自定义主题;
+-   🤝 支持 Tailwind 类库,如 Windi CSS、UnoCSS 等。
+
+# 快速上手
+
+## 安装
+
+已有配置好 Svelte 与 Tailwind 的工程,直接安装。
+
+```bash
+npm i stdf
+# or
+yarn add stdf
+# or
+pnpm i stdf
+```
+
+## 使用
+
+```xml
+<!-- Button Demo -->
+<script>
+import { Button } from 'stdf';
+</script>
+
+<Button>默认</Button>
+```
+
+😓 无工程?用 Vite 示例创建工程,参考 [Vite 文档](https://cn.vitejs.dev/guide/#scaffolding-your-first-vite-project)。并配置 Tailwind CSS,参考 [Tailwind CSS 文档](https://tailwindcss.com/docs/guides/vite)。
+
+# 手机预览
+
+可以手机扫描以下二维码访问手机端 Demo:
+
+<img src="https://stdf.design/assets/qr/demo_qr.png" width="220" height="220" >
+
+
+# 开源协议
+
+本项目基于 [MIT](https://github.com/dufu1991/stdf/blob/main/LICENSE) 协议,请自由地享受和参与开源。

+ 69 - 0
README_en.md

@@ -0,0 +1,69 @@
+<div align="center">
+
+  <img src="https://stdf.design/assets/images/stdf_512px.png" alt="logo" width="100" height="auto" />
+  <h1>S T D F</h1>
+
+[![npm (tag)](https://img.shields.io/npm/v/stdf)](https://www.npmjs.com/package/stdf) [![npm](https://img.shields.io/npm/dw/stdf)](https://www.npmjs.com/package/stdf)
+
+  <h4>
+    <a href="https://github.com/dufu1991/stdf/blob/main/README.md" target="_blank">中文文档</a>
+  <span> · </span>
+    <a href="https://stdf.design?lang=zh_CN" target="_blank">Chinese website</a>
+  <span> · </span>
+    <a href="https://stdf.design?lang=en_US" target="_blank">English website</a>
+  </h4>
+</div>
+
+# Introduction
+
+Mobile web component library based on Svelte and Tailwind.
+
+Simple · Thin · Design · Fast
+
+# Features
+
+-   🚀 No runtime, no virtual DOM, runs faster online;
+-   🧰 Rich API, easily configure component styles that meet your needs;
+-   🍭 Supports dark mode;
+-   📖 Provides extensive Chinese and English documentation and component examples;
+-   🌍 Supports internationalization, with 60+ built-in language packages;
+-   ✍ Based on Svelte and Tailwind, coding is quick and easy;
+-   🫰 User-friendly interaction, animation parameters can be configured, and custom themes are supported;
+-   🤝 Supports Tailwind libraries such as Windi CSS and UnoCSS.
+
+# Getting Started
+
+## Installation
+
+If you have a project configured with Svelte and Tailwind, install directly.
+
+```bash
+npm i stdf
+# or
+yarn add stdf
+# or
+pnpm i stdf
+```
+
+## Usage
+
+```xml
+<!-- Button Demo -->
+<script>
+import { Button } from 'stdf';
+</script>
+
+<Button>Default</Button>
+```
+
+😓 No project? Create a project with Vite and reference the [Vite documentation](https://vitejs.dev/guide/#scaffolding-your-first-vite-project) and the [Tailwind CSS documentation](https://tailwindcss.com/docs/guides/vite) for CSS configuration.
+
+# Mobile Preview
+
+You can scan the QR code below on your mobile phone to access the mobile demo:
+
+<img src="https://stdf.design/assets/qr/demo_qr_en.png" width="220" height="220" >
+
+# 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.

+ 1 - 1
doc/guide/quickStart.md

@@ -29,7 +29,7 @@ import { Button } from 'stdf';
 
 ### 搭建工程
 
-此处用 Vite 示例创建工程,参考 [Vite 文档](https://vitejs.cn/vite3-cn/guide/#trying-vite-online)。
+此处用 Vite 示例创建工程,参考 [Vite 文档](https://cn.vitejs.dev/guide/#scaffolding-your-first-vite-project)。
 
 ```sh
 npm create vite@latest

+ 1 - 1
doc/guide/quickStart_en.md

@@ -29,7 +29,7 @@ import { Button } from 'stdf';
 
 ### Construction project
 
-Use the Vite example to create the project here. See [Vite documentation](https://vitejs.cn/vite3-cn/guide/#trying-vite-online).
+Use the Vite example to create the project here. See [Vite documentation](https://vitejs.dev/guide/#scaffolding-your-first-vite-project).
 
 ```sh
 npm create vite@latest