diff --git a/README.md b/README.md new file mode 100644 index 0000000..e78fc12 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# VQCalendarAttention + +VQCalendarAttentionは、Googleカレンダーから予定を取得し、一日前になった予定をDiscordに通知するプログラムです。Cronosによる定期実行でGoogleカレンダーを監視し、DiscordのWebhookを利用して通知を送信します。 + +## 前提条件 + +- .NET 6.0 SDKがインストールされていること +- GoogleカレンダーAPIのAPIキーと認証情報を取得済みであること +- DiscordサーバーでWebhookを作成し、Webhook URLを取得済みであること + +## インストール方法 + +1. リポジトリをクローンします。 + + git clone https://github.com/yourusername/VQCalendarAttention.git + +2. プロジェクトフォルダに移動し、必要なNuGetパッケージをインストールします。 + + cd VQCalendarAttention + dotnet restore + + +## 設定 + +1. GoogleカレンダーAPIの認証情報を`credentials.json`ファイルとしてプロジェクトフォルダに保存します。 + +2. `appsettings.json`ファイルを作成し、以下の内容を記述します。適切な値に置き換えてください。 + +```json +{ + "GoogleCalendar": { + "CalendarId": "your_calendar_id" + }, + "Discord": { + "WebhookUrl": "your_discord_webhook_url" + }, + "CronJob": { + "CronExpression": "0 9 * * *", + "TimeZone": "UTC" + } +} +``` + +## 実行方法 + +プロジェクトフォルダで以下のコマンドを実行します。 + + dotnet run + +これにより、VQCalendarAttentionプログラムが開始され、設定したCron式に従ってGoogleカレンダーから予定を取得し、一日前になった予定をDiscordに通知します。 +