Skip to content

Commit

Permalink
feat: add readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
Candinya committed May 28, 2024
1 parent 5e2d3d5 commit bfbff91
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Nya Candy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 贡献者图片生成器

## 这是什么

一个用于从 GitHub 拉取贡献者列表及对应的头像,并生成一张聚合图片的工具。

配套一个定期执行的 Actions 流水线,可以将生成的图片托管在 GitHub Pages 服务上。

## 如何使用

它有两个环境变量:

1. `REPO` 指定需要对什么仓库生成贡献者列表,例如默认的是 `Candinya/Kratos-Rebirth`
2. `TOKEN` 指定调用 GitHub API 时使用的访问令牌,如果是针对开源项目、在 GitHub Actions 执行的话,可以像这里的 CI 配置一样设置成 GitHub 自动临时分配的 `${{ github.token }}`

如果您觉得定期执行的策略不合适,您可以自行设定更为合适的策略。

## 开源授权

[MIT](./LICENSE)

0 comments on commit bfbff91

Please sign in to comment.