diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5ec09ca --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f05fc1f --- /dev/null +++ b/README.md @@ -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)