doc: readme

LICENSE

@@ -0,0 +1,24 @@
+Modified MIT License
+
+Software Copyright (c) 2019 OpenAI
+
+We don’t claim ownership of the content you create with GPT-2, so it is yours to do with as you please.
+We only ask that you use GPT-2 responsibly and clearly indicate your content was created using GPT-2.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice need not be included
+with content created by the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,22 @@
-# fear-greed-index-alarm
+# Fear-And-Greed Index Alarm
+
+The Fear-Greed Index Alarm is an open-source repository that allows you to fetch the Fear and Greed Index from CNN every morning using GitHub Actions. This index serves as an indicator of market sentiment. The repository includes a script that checks whether the fetched index value is above or below a specified threshold. If it exceeds the defined range, an exception is raised within the GitHub Actions workflow. You will receive an email notification from github.
+
+## Setup
+
+To set up the Fear-Greed Index Alarm, follow these steps:
+
+1. Make sure you have a GitHub account. If not, create one at [https://github.com](https://github.com).
+2. Fork this repository by clicking the "Fork" button in the top-right corner of this page.
+3. In your forked repository, go to the "Settings" tab.
+4. Under "Repository name", click on "Secrets".
+5. Click on "New repository secret" and add the following secrets:
+   - `FNG_MIN`: The minimum threshold value for the Fear and Greed Index.
+   - `FNG_MAX`: The maximum threshold value for the Fear and Greed Index.
+   Make sure to provide the appropriate values for these secrets.
+6. Once you have added the secrets, the Fear-Greed Index Alarm will be able to access them during the GitHub Actions workflow.
+7. Commit the changes to your forked repository. The GitHub Actions workflow will now be triggered according to the specified schedule.
+
+## Notification
+
+Once you have set up the Fear-Greed Index Alarm and added the necessary secrets, the workflow will automatically run according to the schedule. If the fetched Fear and Greed Index value exceeds the defined range, a notification will be triggered. You can customize the notification settings based on your preferences and requirements.

README_zh.md

@@ -0,0 +1,27 @@
+# Fear-And-Greed Index Alarm
+
+### background
+Fear-And-Greed指数在投资和交易中具有重要的作用。它是一种衡量市场情绪和投资者情绪的指标，可以帮助用户更好地理解市场的风险和机会。通过关注贪婪指数，您可以获得对市场参与者情绪的洞察，从而做出更明智的投资决策。
+
+当市场处于极度贪婪的状态时，投资者往往过度乐观，可能导致资产价格过高，存在泡沫风险。相反，当市场极度恐惧时，投资者情绪低迷，可能会错失投资机会。因此，了解贪婪指数可以帮助您避免过度乐观或过度悲观的行为，从而减少亏损的风险。
+
+### What does this repo do?
+Fear-Greed Index Alarm利用 GitHub Actions 每天从 CNN 获取恐惧与贪婪指数。该指数用作市场情绪的指标。仓库包含一个脚本，用于检查获取的指数值是否超出指定的阈值范围。如果超出了定义的范围，将在 GitHub Actions 工作流中引发异常。您将收到github 发来的email通知。
+
+## 设置
+
+要设置 Fear-Greed Index Alarm，请按照以下步骤进行操作：
+
+1. 确保您拥有 GitHub 账户。如果没有，请在 [https://github.com](https://github.com) 上创建一个账户。
+2. 点击本页面右上角的 "Fork" 按钮，将该仓库进行 Fork。
+3. 在 Fork 后的仓库中，点击 "Settings" 选项卡。
+4. 在 "Repository name" 下方，点击 "Secrets"。
+5. 点击 "New repository secret"，添加以下的 Secrets：
+   - `FNG_MIN`：恐惧与贪婪指数的最小阈值。例如 40。
+   - `FNG_MAX`：恐惧与贪婪指数的最大阈值。例如 60
+   确保为这些 Secrets 提供适当的值。
+6. 添加完 Secrets 后，Fear-Greed Index Alarm 将能够在 GitHub Actions 工作流中访问它们。
+
+## 通知
+
+一旦设置了 Fear-Greed Index Alarm 并添加了必要的 Secrets，工作流将根据计划自动运行。如果获取的恐惧与贪婪指数超出了定义的范围，将触发通知。您可以根据自己的偏好和需求自定义通知设置。