Skip to content

Commit 67a6ffb

Browse files
committed
docs: 📚 update README
1 parent ba0932c commit 67a6ffb

File tree

2 files changed

+94
-1
lines changed

2 files changed

+94
-1
lines changed

README.md

+45-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,48 @@
11
# task_bot
2-
A robot that sends you a daily task and motivates you to cultivate a daily habit, power by `GitHub Actions`.
2+
A robot that sends a daily task and motivates to cultivate a daily habit, power by `GitHub Actions`.
33

4+
[中文](./README_ZH.md)
45

6+
## How it works
7+
8+
1. config daily task in `daily.toml`
9+
10+
```toml
11+
[task.reading]
12+
describe = "Today's review of an old book is %v. Enjoy reading for fun!"
13+
tasks = [
14+
"《animal farm》",
15+
"《The Minimalist Entrepreneur》",
16+
"《Lemo》",
17+
]
18+
```
19+
20+
2. add email config to Actions secrets
21+
22+
Go to repository page -> `Settings` -> `Security` -- `Secrets and variables` -> `Actions` -> `New repository secret`
23+
24+
| Name | Secret(example) |
25+
| :----------- | :---------------- |
26+
| EMAIL_SERVER | smtp.mail.com:587 |
27+
| EMAIL_USER | who_send_task |
28+
| EMAIL_PASS | sender_password |
29+
| EMAIL_FROM | [email protected] |
30+
| EMAIL_TO | [email protected] |
31+
32+
3. schedule task in `send_task.yml`
33+
34+
```yml
35+
on:
36+
schedule:
37+
- cron: '* 2 * * *' # send you email with task detail at 2:00 AM UTC every day
38+
```
39+
40+
more: [cron config](https://en.wikipedia.org/wiki/Cron)
41+
42+
## One more thing
43+
44+
Tell me with an issue if you want more feature about this project.
45+
46+
## License
47+
48+
MIT

README_ZH.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# task_bot
2+
3+
一个发送日常任务,帮助养成日常习惯的机器人,由 `GitHub Actions` 驱动。
4+
5+
[English](./README.md)
6+
7+
## 工作原理
8+
9+
1.`daily.toml` 配置日常任务
10+
11+
```toml
12+
[task.reading]
13+
describe = "今天的回顾旧书是 %v, 享受阅读的乐趣吧!"
14+
tasks = [
15+
"《这些人那些事》",
16+
"《The Minimalist Entrepreneur》",
17+
"《侠隐》",
18+
]
19+
```
20+
21+
2. 把邮件配置添加到 `Actions secrets`
22+
23+
去仓库页面 -> `Settings` -> `Security` -- `Secrets and variables` -> `Actions` -> `New repository secret`
24+
25+
| Name | Secret(示例) |
26+
| :----------- | :---------------- |
27+
| EMAIL_SERVER | smtp.mail.com:587 |
28+
| EMAIL_USER | who_send_task |
29+
| EMAIL_PASS | sender_password |
30+
| EMAIL_FROM | [email protected] |
31+
| EMAIL_TO | [email protected] |
32+
33+
3.`send_task.yml` 编排任务时间
34+
35+
```yml
36+
on:
37+
schedule:
38+
- cron: '* 2 * * *' # 每天 UTC 时间早上两点发送日常任务细节的邮件给你
39+
```
40+
41+
更多配置方法: [cron config](https://en.wikipedia.org/wiki/Cron)
42+
43+
## 还有一件事
44+
45+
如果你想要更多新功能,开一个 issue 告诉我。
46+
47+
## 许可证
48+
49+
MIT

0 commit comments

Comments
 (0)