From 28ac8122afc6e3ff84bcccffbc52c2c7886c38ff Mon Sep 17 00:00:00 2001 From: Mathis Dirksen-Thedens Date: Mon, 4 Feb 2019 18:20:47 +0100 Subject: [PATCH] add readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d87b777 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +![license](https://img.shields.io/github/license/mathisdt/hibiscus-watcher.svg?style=flat) [![Travis-CI Build](https://img.shields.io/travis/mathisdt/hibiscus-watcher.svg?label=Travis-CI%20Build&style=flat)](https://travis-ci.org/mathisdt/hibiscus-watcher/) [![last released](https://img.shields.io/github/release-date/mathisdt/hibiscus-watcher.svg?label=last%20released&style=flat)](https://github.com/mathisdt/hibiscus-watcher/releases) + +# Hibiscus Watcher + +## What does it do? + +This is a tool which makes use of [Hibiscus Payment Server](https://www.willuhn.de/products/hibiscus-server/) +to get account data securely from a bank and generate a report. The report is in plain text +(ideal for mailing it) and can be configured to contain more or less details. + +## Gettings started + +* get the [Java Runtime Environment (JRE)](http://java.com/) in version 8 or newer +* download the [lastest release](https://github.com/mathisdt/hibiscus-watcher/releases/latest) + and unpack it +* start it using the script contained in the "bin" directory or with `java -jar hibiscus-watcher.jar` + and append a combination of these parameters: + * --url : URL of the XML-RPC services of Hibiscus + * --username : username to access the XML-RPC services at the given URL, defaults to 'admin' + * --password : password to access the XML-RPC services at the given URL + * --balances : get the balances of all accounts + * --single : get all single postings of all accounts and generate the more detailed postings report (which also contains the balances) + * --days : go back this amount of days for fetching thepostings, e.g. 7 (the default) - this option is only effective in single postings mode! + * --only-account : account(s) for --balances or --single (multiple times allowed) + * --low : check if the balance of an account is below a minimum account + * --low-account : account(s) for --low (multiple times allowed) + * --low-minimum : minimum amount for --low + * --no-negative : do not get single postings which contain a negative amount of money + * --no-positive : do not get single postings which contain a positive amount of money + * --no-sum : do not print a sum