Skip to content

Commit

Permalink
docs: reinforce example to add multiple quantities/cost (#139)
Browse files Browse the repository at this point in the history
@achannarasappa I also corrected the following sentence, make sure it is correct:
Configuration can also be used to set cost basis lots which will in turn be used to show ~~daily~~ **total** gain or loss on any position.
  • Loading branch information
alt-romes committed Mar 14, 2021
1 parent 08c8316 commit c21074f
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ ticker -w NET,AAPL,TSLA

## Configuration

Configuration is not required to watch stock price but is helpful when always watching the same stocks. Configuration can also be used to set cost basis lots which will in turn be used to show daily gain or loss on any position.
Configuration is not required to watch stock price but is helpful when always watching the same stocks. Configuration can also be used to set cost basis lots which will in turn be used to show total gain or loss on any position.

```yaml
# ~/.ticker.yaml
Expand Down Expand Up @@ -110,6 +110,7 @@ lots:
```
* Symbols not on the watchlist that exists in `lots` will automatically be watched
* To add multiple (`quantity`, `unit_cost`) to the same `symbol`, write two `symbol` entries - see `ARKW` example above
* All properties in `.ticker.yaml` are optional
* `.ticker.yaml` can be set in user home directory, the current directory, or [XDG config home](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)

Expand Down

0 comments on commit c21074f

Please sign in to comment.