ドキュメント類更新

.env_example

@@ -1,5 +1,5 @@
-CONSUMER_KEY=
-CONSUMER_SECRET=
+API_KEY=
+API_KEY_SECRET=
 ACCESS_TOKEN=
 ACCESS_TOKEN_SECRET=
 WEB_HOOK_URL=

.github/workflows/update.yml

@@ -2,9 +2,9 @@ name: get-latest-data
 
 on:
   workflow_dispatch:
-  #schedule:
+  schedule:
     # 毎日21:00分に実行
-  #  - cron: '00 12 * * *'
+    - cron: '00 12 * * *'
 
 jobs:
   build:

README.md

@@ -1,4 +1,19 @@
 # ameblo-notify-v2
 * maintainer: [Asha](https://github.com/asha-ndf)
 * 試験運用中
-* 追記予定
+* 追記予定
+## 概要
+* [SSSRCのアメブロ](https://ameblo.jp/sssrc/)に新規投稿があれば、TwitterとSlackに自動投稿するBotです。
+* TwitterのAPI変更に伴い新しくしました。
+
+## セットアップ
+### ローカル
+* `pip install -r requiremnts.txt`で必要なパッケージをインストールしてください。
+* [.env_example](.env_example)を参考に`.env`を作成してください。
+* `ACCESS_TOKEN`と`ACCESS_TOKEN_SECRET`が未発行の場合は、`init.py`を実行して発行してください。
+### GitHub上
+* `.env`の環境変数をGitHub Secretに設定してください。
+
+
+## 注意
+* `.env`や`.token`はgitignoreしていますが、誤って鍵を載せることの無いように注意してください。