From 6f289b75a9cb27b27222ea0547ad49e143165743 Mon Sep 17 00:00:00 2001 From: Adithya Chari Date: Wed, 27 Nov 2019 14:30:02 -0600 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index f26aab8..bc5410d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # LedgerStockUpdate This application locates any stocks you have in your [ledger-cli](ledger-cli.org) file, then generates a price database of those stocks compatible with the application. + +### Usage + +Build the go file, and run as follows: + +```bash +./[name of executable] -f=[ledger file] -p=[price database file (to create or update)] +``` + +This should spit out a price database file, which can then be used to calculate the market value in ledger as follows: + +```bash +ledger -f [ledger file] --price-db [price database file] -V bal +```