add README

[chaz/homebank2ledger] / bin / homebank2ledger

diff --git a/bin/homebank2ledger b/bin/homebank2ledger
index d4a433fe7609ad4a0d11170f9eee625e2784a5b8..43d4b918d62c198613a9f06e54e1515b5734fb57 100644 (file)
--- a/bin/homebank2ledger
+++ b/bin/homebank2ledger
@@ -4,9 +4,8 @@
 
 =head1 SYNOPSIS
 
-    homebank2ledger --input FILEPATH [--output FILEPATH]
-                    [--version|--help|--manual]
-                    [--format FORMAT] [--account-width NUM]
+    homebank2ledger --input FILEPATH [--output FILEPATH] [--format FORMAT]
+                    [--version|--help|--manual] [--account-width NUM]
                     [--accounts|--no-accounts] [--payees|--no-payees]
                     [--tags|--no-tags] [--commodities|--no-commodities]
                     [--opening-date DATE] [--default-account STR]
@@ -18,12 +17,14 @@ C<homebank2ledger> converts L<HomeBank|http://homebank.free.fr/> files to a form
 L<Ledger|https://www.ledger-cli.org/>. It can also convert directly to the similar
 L<Beancount|http://furius.ca/beancount/> format.
 
-This software is B<EXPERIMENTAL>. I wrote it because I have been maintaining my own personal
-finances using HomeBank (which is awesome) and I wanted to investigate using plain text accounting
-programs which have great support for commodities. It works well enough for my data, but you may be
-using HomeBank features that I don't so there may be cases this doesn't handle well or at all. Feel
-free to file a bug report. This script does NOT try to modify the original HomeBank files it
-converts from, so there won't be any crazy data loss bugs... but no warranty.
+This software is B<EXPERIMENTAL>, in early development. Its interface may change without notice.
+
+I wrote C<homebank2ledger> because I have been maintaining my own personal finances using HomeBank
+(which is awesome) and I wanted to investigate using plain text accounting programs. It works well
+enough for my data, but you may be using HomeBank features that I don't so there may be cases this
+doesn't handle well or at all. Feel free to file a bug report. This script does NOT try to modify
+the original HomeBank files it converts from, so there won't be any crazy data loss bugs... but no
+warranty.
 
 =head2 Features
 
@@ -32,9 +33,9 @@ converts from, so there won't be any crazy data loss bugs... but no warranty.
 * Retains HomeBank metadata, including payees and tags.
 * Offers some customization of the output ledger, like account renaming.
 
-There aren't really any features I think this program is missing -- actually it may have too many
-features -- but if there is anything you think this program could do to be even better, feedback is
-welcome; just file a bug report. Or fork the code and have fun!
+This program is feature-complete in my opinion (well, almost -- see L</CAVEATS>), but if there is
+anything you think it could do to be even better, feedback is welcome; just file a bug report. Or
+fork the code and have fun!
 
 =head2 Use cases
 
@@ -200,6 +201,13 @@ it's just plain text.
     # Run the balances report:
     bean-report ledger.beancount balances
 
+=head1 CAVEATS
+
+=for :list
+* I didn't intend to make this a releasable robust product, so it's lacking tests.
+* Budgets and scheduled transactions are not (yet) converted.
+* There are some minor formatting tweaks I will make (e.g. consolidate transaction tags and payees)
+
 =cut
 
 use warnings;