add support for formatting metadata

[chaz/homebank2ledger] / README.md

diff --git a/README.md b/README.md
index 8c560b109ffd6a9ddbc888f0a9483df1ef68261a..1b1b430a689d4b1f082faf8c9f1c85add7764753 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ homebank2ledger - A tool to convert HomeBank files to Ledger format
 
 # VERSION
 
-version 0.001
+version 0.005
 
 # SYNOPSIS
 
@@ -12,7 +12,7 @@ version 0.001
                     [--version|--help|--manual] [--account-width NUM]
                     [--accounts|--no-accounts] [--payees|--no-payees]
                     [--tags|--no-tags] [--commodities|--no-commodities]
-                    [--opening-date DATE] [--default-account STR]
+                    [--opening-date DATE]
                     [--rename-account STR]... [--exclude-account STR]...
 
 # DESCRIPTION
@@ -119,6 +119,15 @@ Enables commodity declarations.
 
 Defaults to enabled; use `--no-commodities` to disable.
 
+## --budget
+
+Enables budget transactions.
+
+Budget transactions are only supported by the Ledger format (for now). This option is silently
+ignored otherwise.
+
+Defaults to enabled; use `--no-budget` to disable.
+
 ## --opening-date DATE
 
 Specify the opening date for the "opening balances" transaction. This transaction is created (if
@@ -126,12 +135,6 @@ needed) to support HomeBank's ability to configure accounts with opening balance
 
 Date must be in the form "YYYY-MM-DD". Defaults to the date of the first transaction.
 
-## --default-account STR
-
-Specify the account to use for one-sided transactions (if any). Defaults to "Expenses:No Category".
-
-A default account may be necessary because with Ledger all transactions are double-entry.
-
 ## --rename-account STR
 
 Specifies a mapping for renaming accounts in the output. By default `homebank2ledger` tries to come
@@ -205,7 +208,7 @@ it's just plain text.
 # CAVEATS
 
 - I didn't intend to make this a releasable robust product, so it's lacking tests.
-- Budgets and scheduled transactions are not (yet) converted.
+- Scheduled transactions are not (yet) converted.
 - There are some minor formatting tweaks I will make (e.g. consolidate transaction tags and payees)
 
 # BUGS