translate README.md and config/example-lunar-birthday.yaml to English

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.6 (2025-02-08)
+
+- translate README.md and config/example-lunar-birthday.yaml to English
+
 ## v0.2.5 (2025-02-08)
 
 - use Path(config_file).stem as calendar_name

README.md

@@ -1,55 +1,52 @@
 # lunar-birthday-ical
 
-## 这是什么?
+## What is this?
 
-一个使用 Python 3 编写的用于创建农历生日事件的命令行工具.
+A command line tool written in Python 3 for creating lunar birthday events.
 
-`lunar-birthday-ical` 读入一个 YAML 配置文件, 生成 iCalendar 格式的 `.ics` 文件, 可选是否将日历上传到 pastebin, 方便直接订阅,
-示例配置文件请参考 [config/example-lunar-birthday.yaml](https://github.com/ak1ra-lab/lunar-birthday-ical/blob/master/config/example-lunar-birthday.yaml), 注释应该足够能解释每个选项分别是什么含义.
+`lunar-birthday-ical` reads a YAML configuration file and generates an iCalendar `.ics` file. Optionally, it can upload the calendar to pastebin for easy subscription. For an example configuration file, refer to [config/example-lunar-birthday.yaml](https://github.com/ak1ra-lab/lunar-birthday-ical/blob/master/config/example-lunar-birthday.yaml). The comments should be sufficient to explain the meaning of each option.
 
-可以使用 `-h` 或者 `--help` 选项查看命令行工具帮助信息,
+You can use the `-h` or `--help` option to view the command-line tool's help information.
 
 ```
 $ lunar-birthday-ical -h
-usage: lunar-birthday-ical [-h] [-o OUTPUT] input
+usage: lunar-birthday-ical [-h] [-L YYYY MM DD | -S YYYY MM DD] [-o OUTPUT] [config]
 
 Generate iCal events for lunar birthday and cycle days.
 
 positional arguments:
-  input                 input config.yaml, check config/example-lunar-birthday.yaml for example.
+  config                config file in YAML format, check config/example-lunar-birthday.yaml for example.
 
 options:
   -h, --help            show this help message and exit
+  -L YYYY MM DD, --lunar-to-solar YYYY MM DD
+                        Convert lunar date to solar date, add minus sign before leap lunar month.
+  -S YYYY MM DD, --solar-to-lunar YYYY MM DD
+                        Convert solar date to lunar date.
   -o OUTPUT, --output OUTPUT
                         Path to save the generated iCal file.
 ```
 
-## 安装
+## Installation
 
-推荐使用 [`pipx`](https://github.com/pypa/pipx) 来安装 Python 编写的命令行工具, 包括本项目,
+It is recommended to use [`pipx`](https://github.com/pypa/pipx) to install command-line tools written in Python, including this project.
 
 ```ShellSession
 $ pipx install lunar-birthday-ical
   installed package lunar-birthday-ical {{ version }}, installed using Python 3.11.2
   These apps are now globally available
     - lunar-birthday-ical
 done! ✨ 🌟 ✨
-
-$ lunar-birthday-ical config/example-lunar-birthday.yaml
-[2025-01-25 12:17:05,137][lunar_birthday_ical.ical][INFO] iCal file saved to config/example-lunar-birthday.ics
 ```
 
-## 关于 pastebin
-
-在 YAML 配置文件中可选配置是否同时将生成的 `.ics` 文件同时上传 pastebin, 该 pastebin 实例是 repo owner 运行的一个基于 Cloudflare worker 的 pastebin 服务, 实例所使用的代码是 [SharzyL/pastebin-worker](https://github.com/SharzyL/pastebin-worker).
+## About pastebin
 
-如果选择启用 pastebin (`pastebin.enabled`), 在初次执行时, 可以保持 YAML 配置文件中的 `pastebin.name` 和 `pastebin.password` 为空, 命令执行时会自动上传, 上传成功后可以将标准输出中 `lunar_birthday_ical.pastebin` 日志行的 admin 中由 `:` 分隔的 `{{ pastebin.name }}` 和 `{{ pastebin.password }}` 手动填入配置文件, 这样下次再执行时就只会在原本的 URL 上更新, 而不会重新上传, 保持 URL 不变, 避免需要更新订阅日历的链接.
+In the YAML configuration file, you can choose whether to upload the generated `.ics` file to pastebin. This pastebin instance is a Cloudflare worker-based pastebin service ([SharzyL/pastebin-worker](https://github.com/SharzyL/pastebin-worker)) run by the repository owner.
 
-下方为启用 `pastebin.enabled` 后的命令行输出,
+If pastebin (`pastebin.enabled`) is enabled, you can leave `pastebin.name` and `pastebin.password` in the YAML configuration file empty on the first run. After executing the command, it will automatically upload, and upon successful upload, retrieve the `pastebin.name` and `pastebin.password` from the `admin` field in the `lunar_birthday_ical.pastebin` log line in the standard output (`pastebin.name` and `pastebin.password` are split with `:`, as shown in the output below with `XXXXXXXXXXXXXXXXXXXXXXXX` and `YYYYYYYYYYYYYYYYYYYYYYYY`). Manually fill these into the configuration file. This way, on subsequent executions, it will only update the existing URL instead of re-uploading, thus keeping the URL unchanged and avoiding the need to update the calendar URL.
 
-```ShellSession
+```
 $ lunar-birthday-ical config/example-lunar-birthday.yaml
-[2025-01-25 12:17:05,137][lunar_birthday_ical.ical][INFO] iCal file saved to config/example-lunar-birthday.ics
-[2025-01-25 12:17:07,040][httpx][INFO] HTTP Request: POST https://komj.uk/ "HTTP/1.1 200 OK"
-[2025-01-25 12:17:07,041][lunar_birthday_ical.pastebin][INFO] {'url': 'https://komj.uk/{{ pastebin.name }}', 'suggestUrl': 'https://komj.uk/{{ pastebin.name }}/example-lunar-birthday.ics', 'admin': 'https://komj.uk/{{ pastebin.name }}:{{ pastebin.password }}', 'isPrivate': True, 'expire': None}
+[2025-02-08 15:37:54,747][lunar_birthday_ical.ical][INFO] iCal file saved to config/example-lunar-birthday.ics
+[2025-02-08 15:37:57,097][lunar_birthday_ical.pastebin][INFO] {'url': 'https://komj.uk/XXXXXXXXXXXXXXXXXXXXXXXX', 'suggestUrl': 'https://komj.uk/XXXXXXXXXXXXXXXXXXXXXXXX/example-lunar-birthday.ics', 'admin': 'https://komj.uk/XXXXXXXXXXXXXXXXXXXXXXXX:YYYYYYYYYYYYYYYYYYYYYYYY', 'isPrivate': True, 'expire': 604800}
 ```

config/example-lunar-birthday.yaml

@@ -1,51 +1,50 @@
 global:
-  # str: timezone 为 iCal 的全局配置
+  # str: iCal global timezone
   timezone: Asia/Shanghai
 
-  # int: 跳过开始时间在 skip_days 之前的事件
+  # int: Skip events that start before skip_days
   skip_days: 180
-  # int: 最多创建 max_events 个事件
+  # int: Create up to max_events events
   max_events: 20
 
-  # int: cycle_days 最大天数
+  # int: Maximum number of days for cycle_days
   max_days: 30000
-  # int: cycle_days 事件间隔天数
+  # int: Interval days for cycle_days events
   interval: 1000
-  # int: 生日事件的最大年龄
+  # int: Maximum age for birthday events
   max_ages: 80
 
   # bool: true | false
-  # 配置 startdate 是否是 出生日期
-  # bool 选项不能使用 or 来确定优先级
+  # Configure whether startdate is the birth date
   solar_birthday: false
   lunar_birthday: true
 
-  # str: VEVENT 事件的开始时间, 格式为 %H:%M:%S
-  # 时间为当地时间, 写入 iCal 时会转换为 UTC
-  # 注意用双引号括起来, 防止 YAML 自动格式转换
+  # str: Start time of VEVENT event, format is %H:%M:%S
+  # Time is local time, which will be converted to UTC in iCal
+  # Note to enclose the value in double quotes to prevent YAML automatic conversion
   event_time: "10:00:00"
-  # int: VEVENT 事件时长, 单位小时
+  # int: Duration of VEVENT event, in hours
   event_hours: 2
 
-  # []int: 分别提前 x 天创建提醒时间
+  # []int: Create reminders before x days of VEVENT event
   reminders: [1, 3]
-  # []str: VEVENT 事件参会人
+  # []str: VEVENT event attendees
   attendees:
     - charlie.zhang@example.com
     - delta.lee@example.com
 
 # pastebin
 # https://github.com/SharzyL/pastebin-worker
 pastebin:
-  # bool: true | false, 是否启用 pastebin
+  # bool: true | false, whether to enable pastebin
   enabled: true
   baseurl: https://komj.uk
   # str: Supported units: s (seconds), m (minutes), h (hours), d (days), M (months).
   expiration: "7d"
   name: ""
   password: ""
 
-# startdate 为过去的某个日期, 格式为 %Y-%m-%d
+# startdate is a past solar date, format is %Y-%m-%d
 persons:
   - username: 张三
     startdate: 1989-06-03