update to version 0.4.0

CHANGELOG.md

@@ -2,8 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.4.0] - 2022-01-24
+
+### Changed
+
+- CHART-IMG API key is required.
+
+### Added
+
+- `/fear_greed_index` Fear and greed index support.
+
+### Removed
+
+- `/overview`, `/performance`, `/oscillators`, `/moving_avgs` Market screener no longer supported by CHART-IMG API.
+
 ## [0.3.3] - 2021-12-16
 
+### Changed
+
 - Telebot /example with intervals.
 - update handleError().
 - update package dependency `node-telegram-bot-api`.

README.md

@@ -8,12 +8,14 @@ http://t.me/CryptoOpnBot
 
 You can use this bot if you don't want to customize your own. It will always run with the latest version.
 
-## Limitation
+## Notice
 
-- Currently, [CHART-IMG](https://doc.chart-img.com) only supports screenshot image resolution only up to `800x600` with `15` req/min. It will support a higher resolution and rate limit in the future with API-Key.
+CHART-IMG API key is required.
 
 ## Setup
 
+Get your free personal API key at [https://chart-img.com](https://chart-img.com).
+
 ### Clone the repo
 
 ```
@@ -44,28 +46,33 @@ You should create .env file with the following variable(s):
 
 ```
 TELEGRAM_TOKEN=<your_telegram_token>
+CHART_IMG_API_KEY=<your_chart_img_api_key>
 ```
 
 Optional:
 
 ```
 BOT_NAME=@CryptoOpnBot
-CHART_IMG_API_KEY=<your_chart_img_api_key>
+
+CHART_IMG_WIDTH=1024
+CHART_IMG_HEIGHT=768
 ```
 
 ## Quick Run
 
 ### NPM
 
 ```
-npm start -- --telegramToken=<your_telegram_token>
+npm install
+npm start -- --telegramToken=<your_telegram_token> --apiKey=<your_chart_img_api_key>
 ```
 
 ### Docker
 
 ```
-docker run -it --name crypto-opnbot \
+docker run -d --restart=always --name crypto-opnbot \
 -e TELEGRAM_TOKEN=<your_telegram_token> \
+-e CHART_IMG_API_KEY=<your_chart_img_api_key> \
 hawooni/crypto-opnbot:latest
 ```
 
@@ -91,18 +98,6 @@ hawooni/crypto-opnbot:latest
 
 ![/chart](doc/image/chart-indicator.png?raw=true)
 
-### /overview
-
-![/overview](doc/image/overview.png?raw=true)
-
-### /performance
-
-![/performance](doc/image/performance.png?raw=true)
-
-### /oscillators
-
-![/oscillators](doc/image/oscillators.png?raw=true)
-
-### /moving_avgs
+### /fear_greed_index
 
-![/moving_avgs](doc/image/moving_avgs.png?raw=true)
+![/fear_greed_index](doc/image/fear_greed_index.png?raw=true)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opnbot/crypto",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "A simple crypto Telegram Bot based on chart-img.com API.",
   "license": "Apache-2.0",
   "author": "hawooni <[email protected]> (https://hawooni.com)",
@@ -21,15 +21,15 @@
     "@config": "config"
   },
   "dependencies": {
-    "axios": "^0.24.0",
-    "dotenv": "^10.0.0",
+    "axios": "^0.25.0",
+    "dotenv": "^14.2.0",
     "lodash": "^4.17.21",
     "module-alias": "^2.2.2",
     "node-cache": "^5.1.2",
     "node-telegram-bot-api": "^0.56.0",
-    "qs": "^6.10.2",
-    "winston": "^3.3.3",
-    "yargs": "^17.3.0"
+    "qs": "^6.10.3",
+    "winston": "^3.4.0",
+    "yargs": "^17.3.1"
   },
   "devDependencies": {
     "prettier": "^2.5.1"