Skip to content

Commit 0ef0ca7

Browse files
authored
chore: cleanup for README
1 parent 115ef8c commit 0ef0ca7

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
# quote-box
22

3-
从句子json中随机抽取语录,格式化後保存至 `quote.txt`。你可以利用 GitHub Actions 來定時推送到 [Gist](https://gist.github.com) 在个人资料中置顶,以增添其豐富度
3+
从句子json中随机抽取语录,格式化后保存至 `quote.txt`。你可以利用 GitHub Actions 來定时推送到 [Gist](https://gist.github.com) 并在个人资料中置顶,以增添其丰富程度
44

5-
語錄 API 由 [言雅 Elegent TW](https://elegant.tw) 提供。
65

76
> *PS. 若想了解更多「置頂 Gist」專案,請參見*
87
> *<https://github.com/matchai/awesome-pinned-gists>*
98
109
## 使用
1110

12-
你可以使用 GitHub Actions 作業流程來執行操作,以下為一個範例,使用 [Deploy to Gist](https://github.com/marketplace/actions/deploy-to-gist)
11+
首先在需要运行 Actions 的仓库根目录创建 `quotes.json`
12+
```json
13+
[
14+
{"id":1,"sentence":"海内存知己,天涯若比邻。请稍候...","category":1,"cite":"Windows 10/11 OOBE","author":"微软式中文"},
15+
{"id":2,"sentence":"我明白了勇气并不代表没有恐惧,而是战胜恐惧。勇敢的人不是不会恐惧的人,而是战胜了恐惧的人。","category":2,"cite":"...","author":"纳尔逊·曼德拉"},
16+
...
17+
{"id":42,"sentence":"愛是唯一可以超越時間與空間的事物。","category":2,"cite":"星際效應","author":"艾蜜莉亞・布蘭德"}
18+
]
19+
```
20+
21+
你可以使用 GitHub Actions 以将其推送到一个Gist,以下為一個範例,使用 [Deploy to Gist](https://github.com/marketplace/actions/deploy-to-gist)
1322

1423
```yaml
1524
name: Push to Gist
@@ -44,6 +53,10 @@ jobs:
4453
# Authored by Yu-huan Kuo, licensed under MIT License.
4554
```
4655

47-
## 授權
56+
## 授权
4857

58+
原代码:
4959
Copyright (C) 2023, 2024 [Yu-huan Kuo](https://github.com/rnmeow), licensed under [MIT License](https://github.com/rnmeow/quote-box-zh_tw/blob/master/LICENSE.txt).
60+
61+
此Fork:
62+
Licensed under MIT License.

action.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
name: quote-box-zh_tw
2-
author: Yu-huan Kuo <[email protected]>
3-
description: Get a quote to your GitHub Gist, API powered by Elegant TW.
1+
name: quote-box-gist
2+
author: BlockG-ws <[email protected]>
3+
description: Get a quote to your GitHub Gist, just right from your library.
44
runs:
55
using: 'node20'
66
main: 'dist/index.js'

0 commit comments

Comments
 (0)