Release App-HomeBank2Ledger 0.010

[chaz/homebank2ledger] / README.md

diff --git a/README.md b/README.md
index 1b1b430a689d4b1f082faf8c9f1c85add7764753..cc01d27298e4ea3e4fa93bcd2bea0d47b6393040 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.005
+version 0.010
 
 # SYNOPSIS
 
@@ -19,7 +19,7 @@ version 0.005
 
 `homebank2ledger` converts [HomeBank](http://homebank.free.fr/) files to a format usable by
 [Ledger](https://www.ledger-cli.org/). It can also convert directly to the similar
-[Beancount](http://furius.ca/beancount/) format.
+[Beancount](https://beancount.github.io/docs/index.html) format.
 
 This software is **EXPERIMENTAL**, in early development. Its interface may change without notice.
 
@@ -48,6 +48,43 @@ You can migrate the data you have in HomeBank so you can start maintaining your
 Or if you don't plan to switch completely off of HomeBank, you can 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](https://metacpan.org/pod/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