Skip to content

Commit

Permalink
Enhance README documentation with emoji and improved formatting
Browse files Browse the repository at this point in the history
- Updated both README.md and README_zh.md to include emojis for better visual appeal and organization.
- Enhanced section headers for installation, features, privacy, limitations, system requirements, development setup, dependencies, and licenses.
- Improved bilingual support by adding a flag emoji next to the Chinese documentation link.
- These changes aim to improve user experience and accessibility for a diverse audience.
  • Loading branch information
ygsgdbd committed Dec 22, 2024
1 parent a068d0f commit 82e3f47
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# VastWords
# VastWords 📚

<div align="center">
<img src="Screenshots/logo.png" alt="VastWords Logo" width="128" height="128">
Expand All @@ -11,30 +11,30 @@
[![Xcode](https://img.shields.io/badge/Xcode-15.0%2B-blue)](https://developer.apple.com/xcode/)
[![SwiftUI](https://img.shields.io/badge/SwiftUI-3.0-blue)](https://developer.apple.com/xcode/swiftui)

[中文文档](README_zh.md) | English
[🇨🇳 中文文档](README_zh.md) | English

VastWords is a macOS vocabulary application designed to help you quickly collect and learn English words encountered during daily reading. It automatically monitors the clipboard for English words and provides system dictionary lookup functionality. The application runs completely offline, with all data stored locally to ensure your privacy.

<div align="center">
<img src="Screenshots/preview-dark.png" alt="VastWords Preview" width="360">
</div>

## Installation
## 📥 Installation

### Via Homebrew (Recommended)
### 🍺 Via Homebrew (Recommended)

```bash
brew tap ygsgdbd/tap
brew install --cask vastwords
```

### Manual Installation
### 💻 Manual Installation

1. Download the latest release from the [Releases](https://github.com/ygsgdbd/VastWords/releases) page
2. Drag VastWords.app to your Applications folder
3. Launch VastWords from Applications or Spotlight

## Tech Stack
## 🛠 Tech Stack

- SwiftUI + MVVM Architecture
- CoreData + CoreStore for Data Persistence
Expand All @@ -44,7 +44,7 @@ brew install --cask vastwords
- Tuist for Project Management
- SwiftLint + SwiftFormat for Code Standards

## Features
## Features

- 🔄 Smart Monitoring
- Automatic clipboard text monitoring
Expand All @@ -60,44 +60,44 @@ brew install --cask vastwords
- ⭐️ High-performance storage
- 🎯 Performance optimized

## Privacy & Security
## 🔐 Privacy & Security

- 🔒 Completely offline operation
- 💾 Local data storage only
- 🛡️ Uses system built-in features
- 🤝 No user data collection
- 📱 Minimal permissions required

## Limitations
## ⚠️ Limitations

- Text length limit: 10,000 characters
- Word length limit: 2-45 characters
- Automatic filtering of common function words (e.g., a, the, in)

## System Requirements
## 💻 System Requirements

- macOS 13.0 or later
- Apple Silicon or Intel processor

## Development Setup
## 🔧 Development Setup

- Xcode 15.0+
- Swift 5.9+
- SwiftUI
- [Tuist](https://tuist.io) 3.0+

## Dependencies
## 📦 Dependencies

- [CoreStore](https://github.com/JohnEstropia/CoreStore)
- [Defaults](https://github.com/sindresorhus/Defaults)
- [SwifterSwift](https://github.com/SwifterSwift/SwifterSwift)
- [SwiftUIX](https://github.com/SwiftUIX/SwiftUIX)

## License
## 📄 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

### Third-Party Licenses
### 📝 Third-Party Licenses

This project uses the following open source components:

Expand Down
28 changes: 14 additions & 14 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# VastWords
# VastWords 📚

<div align="center">
<img src="Screenshots/logo.png" alt="VastWords Logo" width="128" height="128">
Expand All @@ -11,30 +11,30 @@
[![Xcode](https://img.shields.io/badge/Xcode-15.0%2B-blue)](https://developer.apple.com/xcode/)
[![SwiftUI](https://img.shields.io/badge/SwiftUI-3.0-blue)](https://developer.apple.com/xcode/swiftui)

中文 | [English](README.md)
🇨🇳 中文 | [English](README.md)

VastWords 是一个 macOS 单词本应用,帮助你快速积累日常阅读中遇到的单词。它能够自动监听剪贴板中的英文单词,并提供系统词典查询功能。应用完全离线运行,所有数据均存储在本地,确保您的隐私安全。

<div align="center">
<img src="Screenshots/preview-dark.png" alt="VastWords Preview" width="360">
</div>

## 安装方式
## 📥 安装方式

### 通过 Homebrew 安装(推荐)
### 🍺 通过 Homebrew 安装(推荐)

```bash
brew tap ygsgdbd/tap
brew install --cask vastwords
```

### 手动安装
### 💻 手动安装

1.[Releases](https://github.com/ygsgdbd/VastWords/releases) 页面下载最新版本
2. 将 VastWords.app 拖入应用程序文件夹
3. 从应用程序文件夹或 Spotlight 启动 VastWords

## 技术栈
## 🛠 技术栈

- SwiftUI + MVVM 架构
- CoreData + CoreStore 数据持久化
Expand All @@ -44,7 +44,7 @@ brew install --cask vastwords
- Tuist 项目管理
- SwiftLint + SwiftFormat 代码规范

## 功能特点
## 功能特点

- 🔄 智能监听功能
- 自动监听剪贴板中的文本
Expand All @@ -66,7 +66,7 @@ brew install --cask vastwords
- 智能资源管理,不影响其他应用
- 内存占用小,CPU 使用率低

## 隐私与安全
## 🔐 隐私与安全

- 🔒 完全离线运行,无需网络连接
- 💾 所有数据存储在本地,不会上传到云端
Expand All @@ -84,36 +84,36 @@ brew install --cask vastwords
- 自动调节资源占用
- 不影响用户正常工作

## 使用限制
## ⚠️ 使用限制

- 文本长度上限为 10,000 字符
- 单词长度限制为 2-45 个字符
- 自动过滤常见功能词(如 a, the, in 等)

## 系统要求
## 💻 系统要求

- macOS 13.0 或更高版本
- Apple Silicon 或 Intel 处理器

## 开发环境
## 🔧 开发环境

- Xcode 15.0+
- Swift 5.9+
- SwiftUI
- [Tuist](https://tuist.io) 3.0+

## 第三方依赖
## 📦 第三方依赖

- [CoreStore](https://github.com/JohnEstropia/CoreStore) - CoreData 数据库管理
- [Defaults](https://github.com/sindresorhus/Defaults) - 用户偏好设置存储
- [SwifterSwift](https://github.com/SwifterSwift/SwifterSwift) - Swift 扩展集合
- [SwiftUIX](https://github.com/SwiftUIX/SwiftUIX) - SwiftUI 功能扩展

## 许可证
## 📄 许可证

本项目采用 MIT 许可证开源。这意味着你可以自由地使用、修改和分发本项目,但需要保留原始许可证和版权信息。详见 [LICENSE](LICENSE) 文件。

### 第三方许可证
### 📝 第三方许可证

本项目使用了以下开源组件:

Expand Down

0 comments on commit 82e3f47

Please sign in to comment.