Version 0.008

[chaz/homebank2ledger] / README

diff --git a/README b/README
index 8ee36730b196ad08f0a75eba0f98fc1a8594d834..9a40d413453d06f00ac239afaae136a39bccd094 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,7 @@ NAME
 
 VERSION
 
-    version 0.004
+    version 0.008
 
 SYNOPSIS
 
@@ -58,6 +58,45 @@ DESCRIPTION
     continue to maintain your accounts in HomeBank and use this script to
     also take advantage of the reports Ledger offers.
 
+INSTALL
+
+    There are several ways to install homebank2ledger to your system.
+
+ using cpanm
+
+    You can install homebank2ledger using cpanm. If you have a local perl
+    (plenv, perlbrew, etc.), you can just do:
+
+        cpanm App::Homebank2Ledger
+
+    to install the homebank2ledger executable and its dependencies. The
+    executable will be installed to your perl's bin path, like
+    ~/perl5/perlbrew/bin/homebank2ledger.
+
+    If you're installing to your system perl, you can do:
+
+        cpanm --sudo App::Homebank2Ledger
+
+    to install the homebank2ledger executable to a system directory, like
+    /usr/local/bin/homebank2ledger (depending on your perl).
+
+ Downloading just the executable
+
+    You may also choose to download homebank2ledger as a single executable,
+    like this:
+
+        curl -OL https://raw.githubusercontent.com/chazmcgarvey/homebank2ledger/solo/homebank2ledger
+        chmod +x homebank2ledger
+
+ For developers
+
+    If you're a developer and want to hack on the source, clone the
+    repository and pull the dependencies:
+
+        git clone https://github.com/chazmcgarvey/homebank2ledger.git
+        cd homebank2ledger
+        make bootstrap      # installs dependencies; requires cpanm
+
 OPTIONS
 
  --version
@@ -131,6 +170,15 @@ OPTIONS
 
     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
@@ -224,7 +272,7 @@ 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)