Skip to content

Commit 929b8aa

Browse files
committed
docs: Update README and README.zh-CN to enhance descriptions, improve structure, and add screenshots for better user guidance.
1 parent c56ae02 commit 929b8aa

7 files changed

Lines changed: 62 additions & 28 deletions

File tree

‎README.md‎

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,36 @@ English | [简体中文](README.zh-CN.md)
66
[![Swift](https://img.shields.io/badge/Swift-5.9-orange)](#requirements)
77
[![License](https://img.shields.io/badge/license-Apache--2.0-green)](LICENSE)
88

9-
ClearView is a lightweight macOS menu bar app that helps users maintain healthier screen-time rhythms with periodic eye-break reminders and blue-light filter controls.
9+
![](./docs/img/light-sy.png)
10+
11+
ClearView is a very minimalist macOS app that helps users maintain healthier screen-time rhythms with periodic eye-break reminders and blue-light filter controls.
1012

1113
> Current version: `0.1.0` (`release`)
1214
1315
## Table of Contents
14-
- [Features](#features)
15-
- [Requirements](#requirements)
16-
- [Quick Start (Xcode)](#quick-start-xcode)
17-
- [Build and Test](#build-and-test)
18-
- [DMG Packaging](#dmg-packaging)
19-
- [Project Structure](#project-structure)
20-
- [Configuration and Data](#configuration-and-data)
21-
- [Troubleshooting](#troubleshooting)
22-
- [Roadmap](#roadmap)
23-
- [Contributing](#contributing)
24-
- [Security](#security)
25-
- [Privacy](#privacy)
26-
- [License](#license)
16+
- [ClearView](#clearview)
17+
- [Table of Contents](#table-of-contents)
18+
- [Features](#features)
19+
- [Requirements](#requirements)
20+
- [Quick Start (Xcode)](#quick-start-xcode)
21+
- [Build and Test](#build-and-test)
22+
- [Xcode](#xcode)
23+
- [DMG Packaging](#dmg-packaging)
24+
- [Install from DMG](#install-from-dmg)
25+
- [Unsigned App / Gatekeeper](#unsigned-app--gatekeeper)
26+
- [Command Line (SwiftPM)](#command-line-swiftpm)
27+
- [Project Structure](#project-structure)
28+
- [Configuration and Data](#configuration-and-data)
29+
- [Troubleshooting](#troubleshooting)
30+
- [Roadmap](#roadmap)
31+
- [Contributing](#contributing)
32+
- [Security](#security)
33+
- [Privacy](#privacy)
34+
- [Screens](#screens)
35+
- [License](#license)
2736

2837
## Features
38+
- Minimalist style, supporting both dark and light modes, following the system.
2939
- Menu bar based workflow with an independent main panel.
3040
- Reminder lifecycle: work timer → preparation countdown → break countdown → completion.
3141
- Reminder actions: complete now, snooze, and restart timing.
@@ -150,5 +160,12 @@ If you discover a vulnerability, please follow [SECURITY.md](SECURITY.md) and re
150160
- No cloud sync.
151161
- No telemetry in `v0.1.0`.
152162

163+
## Screens
164+
165+
![](./docs/img/dark-sy.png)
166+
![](./docs/img/dark-hy.png)
167+
![](./docs/img/notice.png)
168+
![](./docs/img/settings.png)
169+
153170
## License
154171
Licensed under Apache License 2.0. See [LICENSE](LICENSE).

‎README.zh-CN.md‎

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,36 @@
66
[![Swift](https://img.shields.io/badge/Swift-5.9-orange)](#环境要求)
77
[![License](https://img.shields.io/badge/license-Apache--2.0-green)](LICENSE)
88

9-
ClearView 是一款轻量的 macOS 菜单栏护眼应用,帮助你通过周期性休息提醒与蓝光过滤控制,建立更健康的屏幕使用节奏。
9+
![](./docs/img/light-sy.png)
10+
11+
ClearView 是一款极简的 macOS 菜单栏护眼应用,帮助你通过周期性休息提醒与蓝光过滤控制,建立更健康的屏幕使用节奏。
1012

1113
> 当前版本:`0.1.0`(`release`)
1214
1315
## 目录
14-
- [功能特性](#功能特性)
15-
- [环境要求](#环境要求)
16-
- [快速开始(Xcode)](#快速开始xcode)
17-
- [构建与测试](#构建与测试)
18-
- [打包 DMG](#打包-dmg)
19-
- [项目结构](#项目结构)
20-
- [配置与数据](#配置与数据)
21-
- [常见问题](#常见问题)
22-
- [路线图](#路线图)
23-
- [贡献](#贡献)
24-
- [安全](#安全)
25-
- [隐私](#隐私)
26-
- [许可证](#许可证)
16+
- [ClearView](#clearview)
17+
- [目录](#目录)
18+
- [功能特性](#功能特性)
19+
- [环境要求](#环境要求)
20+
- [快速开始(Xcode)](#快速开始xcode)
21+
- [构建与测试](#构建与测试)
22+
- [Xcode](#xcode)
23+
- [打包 DMG](#打包-dmg)
24+
- [从 DMG 安装](#从-dmg-安装)
25+
- [未签名应用与 Gatekeeper](#未签名应用与-gatekeeper)
26+
- [命令行(SwiftPM)](#命令行swiftpm)
27+
- [项目结构](#项目结构)
28+
- [配置与数据](#配置与数据)
29+
- [常见问题](#常见问题)
30+
- [路线图](#路线图)
31+
- [贡献](#贡献)
32+
- [安全](#安全)
33+
- [隐私](#隐私)
34+
- [界面](#界面)
35+
- [许可证](#许可证)
2736

2837
## 功能特性
38+
- 极简风格,支持深色和浅色两种模式,跟随系统。
2939
- 菜单栏驱动工作流,配合独立主面板。
3040
- 提醒流程:工作倒计时 → 准备倒计时 → 休息倒计时 → 完成确认。
3141
- 提醒操作:立即完成、稍后提醒、重启计时。
@@ -150,5 +160,12 @@ ClearView/
150160
- 不进行云同步。
151161
- `v0.1.0` 不包含遥测上报。
152162

163+
## 界面
164+
165+
![](./docs/img/dark-sy.png)
166+
![](./docs/img/dark-hy.png)
167+
![](./docs/img/notice.png)
168+
![](./docs/img/settings.png
169+
153170
## 许可证
154171
本项目采用 Apache License 2.0,详见 [LICENSE](LICENSE)。

‎docs/img/dark-hy.png‎

2.18 MB
Loading

‎docs/img/dark-sy.png‎

2.17 MB
Loading

‎docs/img/light-sy.png‎

3.69 MB
Loading

‎docs/img/notice.png‎

1000 KB
Loading

‎docs/img/settings.png‎

1.86 MB
Loading

0 commit comments

Comments
 (0)