From 232785110089343e517b8636680783236057caf6 Mon Sep 17 00:00:00 2001 From: Tony Grosinger Date: Wed, 27 Jul 2022 09:23:19 -0700 Subject: [PATCH] Add description to readme --- README.md | 11 +++++++++++ bin/ledger | 3 --- bin/sort | 3 --- 3 files changed, 11 insertions(+), 6 deletions(-) delete mode 100644 bin/ledger delete mode 100644 bin/sort diff --git a/README.md b/README.md index 163f0bf..a3bdf80 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # MetaLedger +MetaLedger makes it easy to setup [plain text accounting](https://plaintextaccounting.org) by configuring several useful utilities and grouping them into a single Docker Compose script. + +- [hledger](https://hledger.org) for command line interaction and ledger file parsing +- [ledgerbil](https://github.com/scarpent/ledgerbil) for interactive reconciliation +- [Apache Superset](https://superset.apache.org) for awesome custom dashboarding + - Uses [a utility](https://github.com/tgrosinger/ledger-sqlite) to automatically periodically dump your ledger data into a SQLite database that Superset can query. + +Currently it can be run on linux/amd64 and linux/arm64 (except for superset due to [this issue](https://github.com/apache/superset/issues/19433)). Adding more platforms should be possible, they just need to be added to the underlying [hledger-multiarch project](https://github.com/tgrosinger/hledger-multiarch). + +hledger exposes a web interface (configure the port in the `.env` file). There are also utility script in the `bin` directory to make regular tasks quick and easy. + ## Setting Up - Initialize the submodules diff --git a/bin/ledger b/bin/ledger deleted file mode 100644 index 151adfd..0000000 --- a/bin/ledger +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash - -echo TODO diff --git a/bin/sort b/bin/sort deleted file mode 100644 index 151adfd..0000000 --- a/bin/sort +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash - -echo TODO