📝 update readme with new bin feat

Author: Julien-R44

README.md

@@ -27,7 +27,9 @@
 # Features
 - Customizable
 - Auto-fit to terminal size
+- Shipped as library with simple API
 - Shipped as binary for standalone usage
+- Can fetch charts from Yahoo Finance.
 
 # API Usage
 Add this to your `Cargo.toml`
@@ -68,19 +70,26 @@ Download the latest release for your platform [here](https://github.com/Julien-R
 
 ```
 USAGE:
-    cli-candlestick-chart [OPTIONS]
+    cli-candlestick-chart.exe [OPTIONS] --mode <MODE>
 
 FLAGS:
     -h, --help       Prints help information
     -V, --version    Prints version information
 
 OPTIONS:
-        --bear-color <BEAR_COLOR>        Sets the descending candles color.
-        --bull-color <BULL_COLOR>        Sets the ascending candles color.
-        --chart-name <CHART_NAME>        Sets the chart name.
-    -f, --file <FILE>                    File to read candles from, if reading-mode is `*-file.`
-    -r, --reading-mode <READING_MODE>    Choose your reading mode. 
-                                         [possible values: stdin, csv-file, json-file]
+        --bear-color <BEAR_COLOR>    Sets the descending candles color in hexadecimal.
+        --bull-color <BULL_COLOR>    Sets the ascending candles color in hexadecimal.
+        --chart-name <CHART_NAME>    Sets the chart name.
+    -f, --file <FILE>                [MODE:*-file] File to read candles from.`
+    
+        --interval <INTERVAL>        [MODE:*-fetch] The interval you want to retrieve the candles from the API 
+                                     [default: 1d]  
+                                     [possible values: 1m, 2m, 5m, 15m, 30m, 60m, 90m, 1h, 1d, 5d, 1wk, 1mo, 3mo]
+
+    -m, --mode <MODE>                Select the method for retrieving the candles. 
+                                     [possible values: stdin, csv-file, json-file, yahoo-fetch]
+
+    --ticker <TICKER>                [MODE:*-fetch] The broker-side ticker of the asset you want to plot.
 ```
 When requesting the CSV file mode, the library expects a CSV file with `open,high,low,close` headers fields.
 
@@ -99,15 +108,15 @@ When requesting the JSON or stdin mode, the library expects a JSON with the foll
 
 # Examples
 ## API 
-[Basic example with CSV parsing](https://github.com/Julien-R44/cli-candlestick-chart/blob/main/examples/basic-with-csv-parsing.rs) : Run with `cargo run --example basic-with-csv-parsing --features=serde`
+[Basic example with CSV parsing](https://github.com/Julien-R44/cli-candlestick-chart/blob/main/examples/basic-with-csv-parsing.rs) : Run with `cargo run --example basic-with-csv-parsing --features=serde,csv`
 
-[Fetch candles from binance](https://github.com/Julien-R44/cli-candlestick-chart/blob/main/examples/fetch-from-binance.rs) : Run with `cargo run --example fetch-from-binance --features=serde`
+[Fetch candles from binance](https://github.com/Julien-R44/cli-candlestick-chart/blob/main/examples/fetch-from-binance.rs) : Run with `cargo run --example fetch-from-binance --features=serde,reqwest`
 
 ## Binary 
 - Read CSV from file :
 ```bash
 ./cli-candlestick-chart \
-    -r=csv-file \
+    --mode=csv-file \
     -f=./examples/BTC-USD.csv \
     --chart-name="My BTC Chart" \
     --bear-color="#b967ff" \
@@ -130,8 +139,16 @@ echo '[
     "close": 32127.267578
   }
 ]' | ./cli-candlestick-chart \
-    -r=stdin \
+    --mode=stdin \
     --chart-name="My BTC Chart" \
     --bear-color="#b967ff" \
     --bull-color="ff6b99"
 ```
+
+- Fetch from Yahoo Finance :
+```bash
+./cli-candlestick-chart \
+    --mode=yahoo-fetch \
+    --ticker=UBER
+    --interval=1d
+```