Skip to content

Commit

Permalink
📝 更新 README
Browse files Browse the repository at this point in the history
  • Loading branch information
A-kirami committed Aug 17, 2023
1 parent d44e3cd commit c2cd73e
Showing 1 changed file with 90 additions and 1 deletion.
91 changes: 90 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,90 @@
# KiramiBot

<div align="center">

# KiramiBot

✨ 简明轻快的聊天机器人应用 ✨

</div>

<p align="center">
<a href="https://raw.githubusercontent.com/A-kirami/KiramiBot/master/LICENSE">
<img src="https://img.shields.io/github/license/A-kirami/KiramiBot" alt="license">
</a>
<a href="https://pypi.python.org/pypi/kiramibot">
<img src="https://img.shields.io/pypi/v/kiramibot?logo=python&logoColor=edb641" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.10+-blue?logo=python&logoColor=edb641" alt="python">
<a href="https://github.com/psf/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=edb641" alt="black">
</a>
<a href="https://github.com/Microsoft/pyright">
<img src="https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641" alt="pyright">
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="ruff">
</a>
<br />
<a href="https://results.pre-commit.ci/latest/github/A-kirami/KiramiBot/main">
<img src="https://results.pre-commit.ci/badge/github/A-kirami/KiramiBot/main.svg" alt="pre-commit" />
</a>
<a href="https://github.com/A-kirami/KiramiBot/actions/workflows/pyright.yml">
<img src="https://github.com/A-kirami/KiramiBot/actions/workflows/pyright.yml/badge.svg?branch=main&event=push" alt="pyright">
</a>
<a href="https://github.com/A-kirami/KiramiBot/actions/workflows/ruff.yml">
<img src="https://github.com/A-kirami/KiramiBot/actions/workflows/ruff.yml/badge.svg?branch=main&event=push" alt="ruff">
</a>
<br />
<a href="https://kiramibot.dev" target="__blank">
<strong>📖 官方文档</strong>
</a>
&nbsp;&nbsp;|&nbsp;&nbsp;
<a href="https://kiramibot.dev/docs/intro" target="__blank">
<strong>🚀 快速开始</strong>
</a>
&nbsp;&nbsp;|&nbsp;&nbsp;
<a href="https://qm.qq.com/q/7OD95ZDCMM" target="__blank">
<strong>💬 讨论交流</strong>
</a>
</p>

## ⭐️ 简介

KiramiBot 基于 **[NoneBot2](https://v2.nonebot.dev/)** 开发,采用 **[OneBotV11](https://11.onebot.dev/)** 协议通信,能够在**协议支持的平台**上与用户进行交互。

## ✨ 特性

- 🎁 **开箱即用**

- 无门槛一键安装,初次接触更易上手,小白也能即装即用。

- 🎛️ **插件管理**

- 非侵入式的插件管理系统,支持更细粒度的功能与权限控制,更加便于维护和管理。

- 🤝 **开发友好**

- KiramiBot 拥有完整的类型注解,同时提供了常用的功能模块,帮助开发者专注于功能本身。

- 🍀 **开放生态**
- 兼容 NoneBot2 原生插件,可无缝接入插件管理系统。

## 开始

如果你有兴趣使用 KiramiBot,可以访问[官方文档](https://kiramibot.dev/docs/guide/start/manual-install)了解如何开始使用。

## 📋 路线图

请参阅 [Projects](https://github.com/users/A-kirami/projects/6)

## 🤝 贡献

请参阅[贡献指南](./.github/CONTRIBUTING.md)

## 🎊 活动

![Alt](https://repobeats.axiom.co/api/embed/4cdc60f22b220e807018a8e4a19226bb942f6331.svg "Repobeats analytics image")

## 📄 许可证

Code: AGPL-3.0 - 2023 - Akirami

0 comments on commit c2cd73e

Please sign in to comment.