doc: README update

gmasse · Sep 28, 2023 · ccc9c7e · ccc9c7e
1 parent d9da4e3
commit ccc9c7e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,17 @@ It does not require any account creation or API key. Data collection is made rel
 
 The plugin accepts all the symbols supported by Yahoo! Finance.
 
+## Features
+- Market changes (%) will cycle in the navigation bar
+- Market prices details will appear in the dropdown menu (symbols may be different from those in the navigation bar)
+- Any Yahoo! Finance ticker symbol is supported:
+  - stock (ex. `AAPL`)
+  - index (ex. `^IXIC`)
+  - FX rate (ex. `EURUSD=X`)
+  - Cryptocurrency (ex. `BTC-USD`)
+- Plugin automatic update (for ex. in case of YF breaking change, a plugin update will trigger the yahooquery package update)
+- Configuration (symbols, auto-update) via plugin preferences panel
+
 ## Manual installation
 In a terminal:
 ```sh

diff --git a/assets/screenshot_xbar_plugin_browser.png b/assets/screenshot_xbar_plugin_browser.png