docs: add README

This commit is contained in:
Il Harper 2024-02-27 21:19:44 +08:00
parent d54059f994
commit ac5b458993
No known key found for this signature in database
GPG Key ID: 4B71FCA698E7E8EC
2 changed files with 42 additions and 0 deletions

1
README.md Symbolic link
View File

@ -0,0 +1 @@
packages/shell/README.md

41
packages/shell/README.md Normal file
View File

@ -0,0 +1,41 @@
<div align="center">
<a href="https://chronocat.vercel.app" target="_blank" rel="noopener noreferrer">
<img src="https://chronocat.vercel.app/chronocat.svg" alt="Chronocat" width="200px"></img>
</a>
<a href="https://chronocat.vercel.app" target="_blank" rel="noopener noreferrer">
<h1>Chronocat</h1>
</a>
<p>模块化的 Satori 框架</p>
[![License](https://img.shields.io/github/license/chrononeko/chronocat?style=flat-square)](https://github.com/chrononeko/chronocat/blob/master/LICENSE)
</div>
## :warning: 需要注意 :warning:
为了避免此前的事件再次发生,请勿在任何公众平台分享或宣传 Chronocat。如果 Chronocat 被大范围推广Team Chrononeko 将随时存档或私有此项目。
同时,也请勿在无关的群组中提到 Chronocat。Chronocat 不相关的群组里不会有 Chronocat 用户,提出问题也不会得到解答。
## :construction: WIP :construction:
此项目正处于其 v0.x 时期。在创建一个 Pull Request 之前,请务必先在 Bugtracker 上 [创建一个 Issue](https://github.com/chrononeko/bugtracker/issues/new/choose)。
## 使用
请查看 [文档](https://chronocat.vercel.app)。
## 不支持的功能
请查看文档上有关 [不支持的功能](https://chronocat.vercel.app/more/unsupported) 的页面。
## 许可
[AGPL-3.0](https://github.com/chrononeko/chronocat/blob/master/LICENSE)
## 免责声明
使用本项目即表明你同意以下声明:
本项目仅供技术学习、研究和交流使用,不得用作任何其他用途。若因违反上述规定或因违法行为造成的一切后果,其责任一概由使用者承担,与本项目及项目开发团队无关,特此声明。