瀏覽代碼

Update README

杜府 3 年之前
父節點
當前提交
6898973688
共有 2 個文件被更改,包括 1 次插入91 次删除
  1. 1 1
      README.md
  2. 0 90
      components/README.md

+ 1 - 1
README.md

@@ -4,7 +4,7 @@
   [![Releases Status](https://github.com/dufu1991/stdf/actions/workflows/auto-releases.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/auto-releases.yml)
   [![Deploy Status](https://github.com/dufu1991/stdf/actions/workflows/auto-deploy-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/auto-deploy-demo.yml)
   [![Sync Status](https://github.com/dufu1991/stdf/actions/workflows/auto-sync-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/auto-sync-demo.yml)
-
+  
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://stdf.design/assets/favicon_logo_dark/android-chrome-512x512.png">
     <img src="https://stdf.design/assets/favicon_logo/android-chrome-512x512.png" alt="logo" width="100" height="auto" />

+ 0 - 90
components/README.md

@@ -1,90 +0,0 @@
-<div align="center">
-  
-  [![Public Status](https://github.com/dufu1991/stdf/actions/workflows/auto-public-npm.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/auto-public-npm.yml)
-  [![Releases Status](https://github.com/dufu1991/stdf/actions/workflows/auto-releases.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/auto-releases.yml)
-  [![Deploy Status](https://github.com/dufu1991/stdf/actions/workflows/auto-deploy-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/auto-deploy-demo.yml)
-  [![Sync Status](https://github.com/dufu1991/stdf/actions/workflows/auto-sync-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/auto-sync-demo.yml)
-  
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://stdf.design/assets/favicon_logo_dark/android-chrome-512x512.png">
-    <img src="https://stdf.design/assets/favicon_logo/android-chrome-512x512.png" alt="logo" width="100" height="auto" />
-  </picture>
-  <h1>S T D F</h1>
-
-[![NPM Version](https://badgen.net/npm/v/stdf)](https://www.npmjs.com/package/stdf)
-[![NPM Installs](https://badgen.net/npm/dt/stdf?label=installs&icon=npm)](https://www.npmjs.com/package/stdf)
-[![Github Stars](https://badgen.net/github/stars/dufu1991/stdf?icon=github)](https://github.com/dufu1991/stdf)
-[![License](https://badgen.net/github/license/dufu1991/stdf)](https://github.com/dufu1991/stdf/blob/main/LICENSE)
-
-  <h4>
-    <a href="https://github.com/dufu1991/stdf/blob/main/README.md" target="_blank">中文</a>
-    <span> • </span>
-    <a href="https://stdf.design?lang=en_US" target="_blank">Website</a>
-  </h4>
-</div>
-
-# Introduction
-
-Mobile web component library based on [Svelte](https://svelte.dev) and [Tailwind](https://www.tailwindcss.com) .
-
-> **S**imple • **T**hin • **D**esign • **F**ast
-
-# 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 three -party dependence, no need to worry about the three -party library version and security issues.
-
-# Getting Started
-
-## Installation
-
-If you have a project configured with Svelte and Tailwind, install directly.
-
-```bash
-npm i stdf -D
-# or
-pnpm i stdf -D
-```
-
-## 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.
-
-# Preview
-
-Please scan the QR code to access the mobile demo:
-
-<picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://stdf.design/assets/qr/demo_en_dark.png">
-  <img src="https://stdf.design/assets/qr/demo_en.png" width="220" height="220" >
-</picture>
-
-# 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.
-
-# Contributors
-
-<a href="https://github.com/dufu1991/stdf/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=dufu1991/stdf" />
-</a>
-
-# Stargazers over time
-
-[![Stargazers over time](https://starchart.cc/dufu1991/stdf.svg)](https://starchart.cc/dufu1991/stdf)