From fec1cd7323f589af89705e92b0b467c36f53df95 Mon Sep 17 00:00:00 2001 From: wancat Date: Sat, 28 May 2022 18:57:44 +0800 Subject: [PATCH] Update readme --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 932e51c..16aa663 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,18 @@ # LedgerStockUpdate -This repository has been archived, and the project has been ported to Rust, please refer to the [SourceHut page](https://sr.ht/~adchari/ledgerdb) +This application locates any stocks/crypto currencies you have in your [ledger-cli](https://ledger-cli.org) file, then generates a price database of those stocks compatible with the application, using quotes from Yahoo Finance. -This application locates any stocks you have in your [ledger-cli](https://ledger-cli.org) file, then generates a price database of those stocks compatible with the application. +Forked from [adchari/LedgerStockUpdate](https://github.com/adchari/LedgerStockUpdate), add some features: +* Add name mapping functionality: use BTC in your ledger and BTC-USD for online quotes +* Replace API from Alpha Vantage, without the needs of obtaining API token +* Recursively transform the quotes to single currency ### Usage Build the go file, and run as follows: ```bash -./[name of executable] -f=[ledger file] -p=[price database file (to create or update)] -a=[Alpha Vantage API token] -b=[Name of ledger binary] +./[name of executable] -f=[ledger file] -p=[price database file (to create or update)] -b=[Name of ledger binary] -m=[name mapping file] ``` This should spit out a price database file, which can then be used to calculate the market value in ledger as follows: @@ -17,3 +20,4 @@ This should spit out a price database file, which can then be used to calculate ```bash ledger -f [ledger file] --price-db [price database file] -V bal ``` +