Add description to readme
This commit is contained in:
parent
45e203f4a2
commit
2327851100
11
README.md
11
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
|
||||
|
@ -1,3 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
echo TODO
|
Reference in New Issue
Block a user