Skip to content

Commit 641b40e

Browse files
committed
docs(README): update descriptions and add credits section for SoybeanUI and SoybeanHeadless
1 parent b109f54 commit 641b40e

File tree

4 files changed

+40
-12
lines changed

4 files changed

+40
-12
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ English | [中文](./README.zh-CN.md)
55
[![license](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
66
[![github stars](https://img.shields.io/github/stars/soybeanjs/soybean-ui)](https://github.com/soybeanjs/soybean-ui)
77

8-
SoybeanUI is a modern, high-quality UI component library for Vue 3, built on top of a robust headless foundation. It provides a comprehensive set of accessible, customizable, and performant components.
8+
SoybeanUI is an elegant, modern, accessible and high-quality UI component library with shadcn-like design for Vue 3, built on top of a robust headless foundation. It provides a comprehensive set of accessible, customizable, and performant components.
99

1010
## 📚 Architecture
1111

@@ -102,6 +102,15 @@ import { AccordionRoot, AccordionItem, AccordionTrigger, AccordionContent } from
102102
- **Customizable**: Built with UnoCSS and `tailwind-variants` for easy theming.
103103
- **Lightweight**: Tree-shakable components.
104104

105+
## 💝 Credits
106+
107+
- [reka-ui](https://github.com/unovue/reka-ui)
108+
- [oku-ui](https://github.com/oku-ui/primitives)
109+
- [shadcn-vue](https://github.com/unovue/shadcn-vue)
110+
- [shadcn/ui](https://github.com/shadcn/ui)
111+
- [nuxt-ui](https://github.com/nuxt/ui)
112+
- [unocss](https://github.com/unocss/unocss)
113+
105114
## 🗺️ Roadmap
106115

107116
### Components

README.zh-CN.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![license](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
66
[![github stars](https://img.shields.io/github/stars/soybeanjs/soybean-ui)](https://github.com/soybeanjs/soybean-ui)
77

8-
SoybeanUI 是一个基于 Vue 3 的现代化、高质量 UI 组件库,构建在强大的 Headless 基础之上。它提供了一套全面、可访问、可定制且高性能的组件。
8+
SoybeanUI 是一个优雅、现代、可访问且高质量的 UI 组件库,具有 shadcn-like 设计,适用于 Vue 3,构建在强大的 Headless 基础之上。它提供了一套全面、可访问、可定制且高性能的组件。
99

1010
## 📚 架构
1111

@@ -102,6 +102,15 @@ import { AccordionRoot, AccordionItem, AccordionTrigger, AccordionContent } from
102102
- **可定制**: 基于 UnoCSS 和 `tailwind-variants` 构建,易于主题化。
103103
- **轻量级**: 支持 Tree-shaking 的组件。
104104

105+
## 💝 致谢
106+
107+
- [reka-ui](https://github.com/unovue/reka-ui)
108+
- [oku-ui](https://github.com/oku-ui/primitives)
109+
- [shadcn-vue](https://github.com/unovue/shadcn-vue)
110+
- [shadcn/ui](https://github.com/shadcn/ui)
111+
- [nuxt-ui](https://github.com/nuxt/ui)
112+
- [unocss](https://github.com/unocss/unocss)
113+
105114
## 🗺️ 路线图
106115

107116
### 组件

headless/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ English | [中文](./README.zh-CN.md)
77

88
A collection of unstyled, accessible UI primitives for Vue 3.
99

10-
## Introduction
10+
## 📖 Introduction
1111

1212
`@soybeanjs/headless` provides the core logic and accessibility features for UI components, without any styles. It is designed for developers who want to build their own design systems with full control over the visual appearance.
1313

14-
## Installation
14+
## 📦 Installation
1515

1616
```bash
1717
pnpm add @soybeanjs/headless
1818
```
1919

20-
## Usage
20+
## 🚀 Usage
2121

2222
Import the components and compose them to build your UI.
2323

@@ -50,13 +50,18 @@ import {
5050
</template>
5151
```
5252

53-
## Features
53+
## Features
5454

5555
- **Unstyled**: No CSS included. You bring your own styles.
5656
- **Accessible**: Handles WAI-ARIA roles, focus management, and keyboard navigation.
5757
- **Composable**: Components are designed to be composed together.
5858
- **Vue 3**: Built for Vue 3 using Composition API.
5959

60-
## Documentation
60+
## 📚 Documentation
6161

6262
For full documentation and styled components, visit the [SoybeanUI repository](https://github.com/soybeanjs/soybean-ui).
63+
64+
## 💝 Credits
65+
66+
- [reka-ui](https://github.com/unovue/reka-ui)
67+
- [oku-ui](https://github.com/oku-ui/primitives)

headless/README.zh-CN.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@
77

88
一套用于 Vue 3 的无样式、可访问的 UI 组件集合。
99

10-
## 简介
10+
## 📖 简介
1111

1212
`@soybeanjs/headless` 为 UI 组件提供了核心逻辑和可访问性功能,但不包含任何样式。它专为希望构建自己的设计系统并完全控制视觉外观的开发者而设计。
1313

14-
## 安装
14+
## 📦 安装
1515

1616
```bash
1717
pnpm add @soybeanjs/headless
1818
```
1919

20-
## 使用方法
20+
## 🚀 使用方法
2121

2222
引入组件并组合它们以构建您的 UI。
2323

@@ -50,13 +50,18 @@ import {
5050
</template>
5151
```
5252

53-
## 特性
53+
## 特性
5454

5555
- **无样式**: 不包含 CSS。您可以使用自己的样式。
5656
- **可访问性**: 处理 WAI-ARIA 角色、焦点管理和键盘导航。
5757
- **可组合**: 组件设计为可组合使用。
5858
- **Vue 3**: 使用 Composition API 为 Vue 3 构建。
5959

60-
## 文档
60+
## 📚 文档
6161

6262
有关完整文档和带样式的组件,请访问 [SoybeanUI 仓库](https://github.com/soybeanjs/soybean-ui)
63+
64+
## 💝 致谢
65+
66+
- [reka-ui](https://github.com/unovue/reka-ui)
67+
- [oku-ui](https://github.com/oku-ui/primitives)

0 commit comments

Comments
 (0)