Skip to content

Commit

Permalink
docs: added env info
Browse files Browse the repository at this point in the history
  • Loading branch information
m1sk9 committed Oct 11, 2023
1 parent b41c43d commit 3a5beb3
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
# idea-reaction

[![Build idea-reaction](https://github.com/GiganticMinecraft/idea-reaction/actions/workflows/build.yaml/badge.svg)](https://github.com/GiganticMinecraft/idea-reaction/actions/workflows/build.yaml)
[![clippy](https://github.com/GiganticMinecraft/idea-reaction/actions/workflows/clippy.yaml/badge.svg)](https://github.com/GiganticMinecraft/idea-reaction/actions/workflows/clippy.yaml)
[![rustfmt](https://github.com/GiganticMinecraft/idea-reaction/actions/workflows/fmt.yaml/badge.svg)](https://github.com/GiganticMinecraft/idea-reaction/actions/workflows/fmt.yaml)
[![Release idea-reaction-token](https://github.com/GiganticMinecraft/idea-reaction/actions/workflows/release.yaml/badge.svg)](https://github.com/GiganticMinecraft/idea-reaction/actions/workflows/release.yaml)

アイデア投稿履歴のリアクションを制限する Discord Bot.

## Introduction

- Docker Container 上での動作を想定しています.
- `compose.yaml` を配置しているリポジトリ内に `.env` ファイルを用意し, 環境変数を設定してください.
- [`compose.yaml`](./compose.yaml) を配置しているリポジトリ内に `.env` ファイルを用意し, 環境変数を設定してください.
- Docker Compose v1 (非推奨) での動作は想定していません.
- 設定後 `docker compose up -d` で起動できます.

## Environment Variables

| Name | Description | Default |
| `DISCORD_TOKEN` | Discord Bot のトークン | - |
| Name | Description |
| ---- | ---- |
| `DISCORD_TOKEN` | Discord Bot のトークン |
| `TARGET_CHANNEL_ID` | 監視対象チャンネルのID |
| `TARGET_WEBHOOK_ID` | 監視対象WebhookのID |
| `TARGET_GUILD_ID` | 監視対象ギルドのID |

## Configuration

- idea-reaction は `config.yaml` によって設定が変更可能です.

```yaml
reaction:
emoji: ["👍", "👎"] # リアクションに使用する絵文字を文字列で指定する
reaction: ["👍", "👎"] # リアクションに使用する絵文字を文字列の配列(Vec)で指定する
```

0 comments on commit 3a5beb3

Please sign in to comment.