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.

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

Updated readme with new --show-holdings feature #108

Merged
merged 1 commit into from
Feb 15, 2021
Merged
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ ticker -w NET,AAPL,TSLA
| |--show-fundamentals||display open price, previous close, and day range |
| |--show-separator||layout with separators between each quote|
| |--show-summary||show total day change, total value, and total value change|
| |--show-holdings||show holdings including weight, average cost, and quantity|
| |--sort||sort quotes on the UI - options are change percent (default), `alpha`, `value`, and `user`|
| |--proxy||proxy URL for requests (default is none)|

Expand All @@ -87,6 +88,7 @@ show-summary: true
show-tags: true
show-fundamentals: true
show-separator: true
show-holdings: true
interval: 5
currency: USD
watchlist:
Expand All @@ -112,7 +114,7 @@ lots:

### Display Options

With `--show-summary`, `--show-tags`, `--show-fundamentals`, and `--show-separator` options set, the layout and information displayed expands:
With `--show-summary`, `--show-tags`, `--show-fundamentals`, `--show-holdings`, and `--show-separator` options set, the layout and information displayed expands:

<img src="./docs/ticker-all-options.png" />

Expand Down