Skip to content

README写得太简单,完全看不懂插件用途和用法 #5

Description

@is-wuyi

项目功能挺实用,但 README 真的太潦草了,看完后一头雾水,不知道插件到底干嘛、怎么用、命令格式也没写。建议至少写明:

  • 插件是干什么用的,适配哪个版本的 MCDReforged
  • 核心用法示例(命令格式和效果)
  • 主要配置项说明
  • 有无机器人功能,说明一下排行榜/数据统计的具体含义

这样有助于后来的服务器主快速上手和避坑。

如果不会写文档,可以参考别的 MCDR 插件项目文档,或者直接把主要命令贴出来也行!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions