Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: README update #5

Merged
merged 2 commits into from
Sep 28, 2023
Merged

doc: README update #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a34380
doc: README update
gmasse Sep 27, 2023
9282dd0
doc: update plugin preferences image
gmasse Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file modified assets/screenshot_xbar_plugin_browser.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.