koishi - npm Package Compare versions

Comparing version 1.0.0-alpha.2 to 1.0.0-alpha.3

package.json

 {
   "name": "koishi",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.3",
   "main": "dist/index.js",
@@ -29,6 +29,6 @@ "typings": "dist/index.d.ts",
     "chalk": "^3.0.0",
-    "koishi-core": "^1.0.0-alpha.2",
-    "koishi-plugin-common": "^1.0.0-alpha.2",
-    "koishi-utils": "^1.0.0-alpha.0"
+    "koishi-core": "^1.0.0-alpha.3",
+    "koishi-plugin-common": "^1.0.0-alpha.3",
+    "koishi-utils": "^1.0.0-alpha.1"
   }
 }

README.md

@@ -0,3 +1,77 @@
+<img width="160" src="https://koishijs.github.io/koishi.png" alt="logo">
+
 # Koishi
 
-[![npm](https://img.shields.io/npm/v/koishi?style=flat-square)](https://www.npmjs.com/package/koishi)
+Koishi 是一个在 [Node.js](https://nodejs.org/) 环境下运行，基于 [CoolQ](https://cqp.cc) 和 [CQHTTP](https://cqhttp.cc) 的 QQ 机器人框架。
+
+它的名字和图标来源于东方 Project 中的角色古明地恋（Komeiji Koishi）。
+
+## 特性
+
+### 开箱即用的 CLI
+
+Koishi 高度配置化的 CLI 命令可以让你无需写代码就搭建属于你的机器人。与此同时，CLI 还配备了丰富和人性化的提示，进一步提高调试体验。
+
+参见：[快速上手](https://koishijs.github.io/guide/getting-started.html) / [配置文件](https://koishijs.github.io/guide/config-file.html)
+
+### 功能强大的 API
+
+Koishi 的 API 包括下面几个部分：
+
+- [Receiver](https://koishijs.github.io/guide/receive-and-send.html#接收器-receiver)：将收到的信息转化为事件进行分发，且同时支持 HTTP 和 WebSocket
+- [Sender](https://koishijs.github.io/guide/receive-and-send.html#发送器-sender)：完美契合 CQHTTP API 的一套异步发送器，同样支持 HTTP 和 WebSocket
+- [Middleware](https://koishijs.github.io/guide/receive-and-send.html#中间件-middleware)：支持异步操作的中间件系统，可以让你高效地处理每一条信息
+- [Context](https://koishijs.github.io/guide/plugin-and-context.html#创建上下文)：用上下文描述了机器人可能的运行环境，让你得以对不同的群进行不同的处理
+- [Plugin](https://koishijs.github.io/guide/plugin-and-context.html#使用插件-api)：将逻辑以插件的形式封装，可以实现更好的模块化和配置化
+- [Command](https://koishijs.github.io/guide/command-system.html)：Koishi 的核心功能之一，使用链式调用轻松创建指令，同时提供了大量的实用特性
+- [Database](https://koishijs.github.io/guide/using-database.html)：内置的数据库系统，但并不依赖具体的数据库实现，无论何种数据库都可以在 Koishi 中使用
+
+每一个部分都经过了精心的编写，可以让你轻松实现任何需求。
+
+参见：[API 文档](https://koishijs.github.io/api/index.html)
+
+### 丰富的生态系统
+
+Koishi 在编写时，也同样编写了大量的官方插件作为补充。它们有些 Koishi 的基础功能，有些则为 Koishi 的使用提供了许多便利。更重要的是，这数十个插件都可以作为 Koishi 插件开发的极好示范。
+
+参见：[官方插件](https://koishijs.github.io/plugins/common.html)
+
+### 多机器人支持
+
+Koishi 原生地支持了多机器人开发，同时为这些机器人之间互通数据、共用服务器、保证数据安全提供了原生的解决方案，这有助于在保持高性能的同时，将腾讯风控造成的影响降低到最小。
+
+参见：[多机器人开发](https://koishijs.github.io/guide/multiple-bots.html)
+
+### 类型与单元测试
+
+Koishi 在开发时借助了下面的工具：
+
+- 使用 [TypeScript](http://www.typescriptlang.org/) 编写
+- 使用 [Jest](https://jestjs.io/) 进行单元测试
+- 使用 [Eslint](https://eslint.org/) 进行代码风格检查
+- 使用 [GitHub Actions](https://github.com/features/actions) 进行持续集成
+
+这保证了其代码的正确性和可读性。
+
+## 安装
+
+```sh
+# 进入文件夹
+cd my-bot
+
+# 安装 Koishi
+npm i koishi -g
+
+# 初始化配置文件
+koishi init
+
+# 运行你的 Bot
+koishi run
+```
+
+现在可以对你的机器人说话了：
+
+```
+> echo hello world
+< hello world
+```

No alert changes

Improved metrics

Total package byte prevSize

14007

increased by32.08%

Number of lines in readme file

78

increased by1850%

Dependency changes

• Updatedkoishi-core@^1.0.0-alpha.3

• Updatedkoishi-plugin-common@^1.0.0-alpha.3

• Updatedkoishi-utils@^1.0.0-alpha.1