Skip to content

Commit b762653

Browse files
committed
docs: add CHANGELOG
1 parent ec04c71 commit b762653

3 files changed

Lines changed: 106 additions & 2 deletions

File tree

.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
src/i18n/**.ts linguist-generated=true
1+
src/i18n/locales/**.ts linguist-generated=true
22
src/types/generated/**.ts linguist-generated=true

.github/workflows/pr-check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ on:
1717
paths-ignore:
1818
- 'docs/**'
1919
- '**.md'
20-
- 'src/i18n/**.ts'
20+
- 'src/i18n/locales/**.ts'
2121
- '.github/workflows/**'
2222

2323
jobs:

CHANGELOG.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## 0.2.1 (2025.11.6)
10+
11+
### 🚀 Improvements
12+
13+
- Update 8 languages support: Japanese, German, French, Spanish, Russian, Portuguese, Italian, Korean.
14+
- Disable noisy upstream logs.
15+
- DND feature will not cause panic on Windows platform anymore.
16+
17+
## 0.2.0 (2025.11.6)
18+
19+
### 🎉 Features
20+
21+
- Add DND(Do Not Disturb) mode detection on Windows, Linux, and macOS to automatically pause break reminders when Focus Assist or equivalent mode is active.
22+
- Windows uses WNF API, Linux uses D-Bus, macOS uses polling. Welcomes users to enable it via `monitorDnd` setting and provide feedback.
23+
- Windows platform has been tested, while Linux and macOS has not.
24+
- Add App Exclusion feature to whitelist applications that temporarily disable break reminders when they are in the foreground or based on more complex rules.
25+
- Users can configure excluded apps via `excludedApps` setting in the config file.
26+
27+
### 🚀 Improvements
28+
29+
- Pause and Resume action now work for Attention Timer too.
30+
- Use [user-Idle2](https://crates.io/crates/user-idle2) instead of [user-Idle](https://crates.io/crates/user-idle) for Linux Wayland idle detection.
31+
- Hide debug section in advanced settings panel.
32+
33+
### 📝 Documentation
34+
35+
- Update related documentation for DND monitoring and App Exclusion features.
36+
37+
## 0.1.4 (2025.11.5)
38+
39+
### 🚀 Improvements
40+
41+
- Supports retaining old values when switching background and audio settings
42+
43+
### 📝 Documentation
44+
45+
- Updates related infomation in CONFIGURATION.md
46+
47+
### ⚠️ Breaking Changes
48+
49+
- Structure of `background` and `audio` settings in configuration file has changed. If you encountered compatibility issues (impossible I think since no one use now), please update your config file manually according to the following example:
50+
51+
For `background` setting:
52+
53+
```toml
54+
[schedules.miniBreaks.theme.background]
55+
solid = "#cedae9"
56+
57+
# or
58+
[schedules.miniBreaks.theme.background]
59+
imagePath = "/path/to/your/image.png"
60+
61+
# or
62+
[schedules.miniBreaks.theme.background]
63+
imageFolder = "/path/to/your/folder"
64+
```
65+
66+
should be changed to
67+
68+
```toml
69+
[schedules.miniBreaks.theme.background]
70+
current = "solid" # options: "solid", "imagePath", "imageFolder"
71+
solid = "#cedae9"
72+
imagePath = "/path/to/your/image.png"
73+
imageFolder = "/path/to/your/folder"
74+
```
75+
76+
For `audio` setting:
77+
78+
```toml
79+
[schedules.longBreaks.audio]
80+
source = "builtin"
81+
name = "gentle-bell"
82+
volume = 0.6
83+
84+
# or
85+
[schedules.longBreaks.audio]
86+
source = "filePath"
87+
path = "/path/to/your/audio.mp3"
88+
volume = 0.6
89+
```
90+
91+
should be changed to
92+
93+
```toml
94+
# NOTE: `source` is renamed to `current`, and `name`/`path` are renamed to `builtinName`/`filePath`
95+
[schedules.longBreaks.audio]
96+
current = "builtin" # options: "none", "builtin", "filePath"
97+
builtinName = "gentle-bell"
98+
filePath = "/path/to/your/audio.mp3"
99+
volume = 0.6
100+
```
101+
102+
## 0.1.3 (2025.11.5) 🎉 FIRST RELEASE
103+
104+
Initial release.

0 commit comments

Comments
 (0)