Skip to content

Commit

Permalink
write README
Browse files Browse the repository at this point in the history
  • Loading branch information
Azuki-bar committed Dec 27, 2022
1 parent 503d2b0 commit 428cf0c
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# discotp

## En

### What is this?

this application is OTP(One Time Password) client works as Discord app.

## Jp

### これはなに

これは Discord のアプリケーションとして使えるワンタイムパスワードクライアントです。

### 設定方法

以下の環境変数を設定してください。

|キー||
|`DISCORD_APP_TOKEN`|DiscordのBotトークン|
|`DISCORD_GUILD_ID`|DiscordのGuildIDです。|
|`ALLOWRD_REPLY_CHANNEL_IDS`|メッセージの返答を許可するチャンネルのIDです。分割文字は`,`で複数設定できます|
|`GOOGLE_TOTP_TOKEN`|GoogleのTOTPトークンです。「QRコードを読み取れない」のような場所をクリックすると取得できます|

### リリース方法

最新のコミットに対してタグを貼ってください。(自動化したいです)
そしてそのタグをプッシュすると自動的にリリースノートが生成されます。
Assets として(Win, Mac, Linux) x (x86_64, arm64, i386)のビルド成果物が生成されます。
また ghcr.io にコンテナイメージがプッシュされます。これは x86_64 と arm64 のみに対応です。

```bash
git tag v(SEM_VER)
git push --tags
```

0 comments on commit 428cf0c

Please # to comment.