From bfa815f08d5864e30fb4d008f3d234a1a41d8be6 Mon Sep 17 00:00:00 2001 From: Gabriel Augendre Date: Wed, 26 Feb 2020 18:26:36 +0100 Subject: [PATCH] Update readme --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a109a5d..913d543 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,20 @@ ## Usage ```shell script -process-bpvf /path/to/ofxfile.ofx -# Or -process-revolut /path/to/csvfile.csv +Usage: ynab [OPTIONS] COMMAND [ARGS]... + +Options: + --version Show the version and exit. + -h, --help Show this message and exit. + +Commands: + bpvf Process BPVF bank statement (OFX) + ce Process CE bank statement (OFX) + config + revolut Process Revolut bank statement (CSV) ``` -It will write a `processed` file in the same folder with the same extension. +All transactions will be pushed to YNAB. If this is your first time using the script, +it will open a generated config file for you to fill up. -It will not overwrite the original file. +The account and budget UUID are found in the YNAB url when using the web app.