docs: add README

PNArchives · Oct 16, 2023 · aeda4be · aeda4be
1 parent 1502440
commit aeda4be
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# MHNow-Bot
+
+## 機能一覧
+
+- コマンド`/paint`: マーキングしたモンスターを登録する
+- コマンド`/paint-list`: マーキングしたモンスターの一覧をみる
+
+## 使い方
+
+1. [Discord Developer](https://discord.com/developers/applications)にアクセスしてDiscord Application(Bot)を作成する
+2. Botのトークンをコピーしておく
+3. データベースの１つであるPostgreSQLを使用するので、自分の環境に用意してください。Dockerが使えるなら、`docker`ディレクトリにあるcomposeファイルを使っても問題ない
+4. [Releases](https://github.com/yechentide/mhnow-bot/releases)から実行ファイルをダウンロードする
+5. その実行ファイルと同じディレクトリに、`.mhnow.toml`設定ファイルを置く
+6. 設定ファイル内の`bot_token`を必ず自分のトークンに変える
+7. 実行ファイルを起動する
+
+## イメージ
+
+![サンプル01](docs/images/sample01.png)
+![サンプル02](docs/images/sample02.png)
diff --git a/docs/images/sample01.png b/docs/images/sample01.png
diff --git a/docs/images/sample02.png b/docs/images/sample02.png