diff --git a/README.md b/README.md index 6daa10b..d7fcfbe 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,14 @@ by the `hledger` command line tool: balances; contributed capital, not legal ownership) - 🧾 Journal (a detailed transaction log: date, description and postings) +## Screenshots + +Rendered from the [example journal](docs/example.journal): + +| Accounts | P&L | Journal | +| - | - | - | +| [![Accounts](docs/screenshots/accounts.png)](docs/screenshots/accounts.png) | [![P&L](docs/screenshots/pnl.png)](docs/screenshots/pnl.png) | [![Journal](docs/screenshots/journal.png)](docs/screenshots/journal.png) | + ## Installation The plugin requires the `hledger` executable on the server. diff --git a/docs/example.journal b/docs/example.journal new file mode 100644 index 0000000..66dd0b9 --- /dev/null +++ b/docs/example.journal @@ -0,0 +1,36 @@ +; Example journal for the Discourse hledger plugin. +; A community collective with member contributions, dues, donations and costs. + +2024-01-01 Opening balances + assets:bank:checking 2500.00 USD + assets:bank:savings 5000.00 USD + equity:members:@alice -4500.00 USD + equity:members:@bob -3000.00 USD + +2024-01-15 Membership dues, Q1 + assets:bank:checking 300.00 USD + revenues:dues + +2024-01-20 Interest-free member loan, @carol + assets:bank:checking 500.00 USD + liabilities:loans:@carol + +2024-02-03 Donation from @carol + assets:bank:checking 150.00 USD + revenues:donations + +2024-02-20 Server hosting, February + expenses:hosting 40.00 USD + assets:bank:checking + +2024-03-05 Podcast microphone + expenses:equipment 120.00 USD + assets:bank:checking + +2024-03-22 Travel reimbursement, @alice + expenses:travel 180.00 USD + assets:bank:checking + +2024-04-02 Transfer to savings + assets:bank:savings 1000.00 USD + assets:bank:checking \ No newline at end of file diff --git a/docs/screenshots/accounts.png b/docs/screenshots/accounts.png new file mode 100644 index 0000000..eb3bda3 Binary files /dev/null and b/docs/screenshots/accounts.png differ diff --git a/docs/screenshots/balance-sheet.png b/docs/screenshots/balance-sheet.png new file mode 100644 index 0000000..dd00be3 Binary files /dev/null and b/docs/screenshots/balance-sheet.png differ diff --git a/docs/screenshots/equity.png b/docs/screenshots/equity.png new file mode 100644 index 0000000..ab5aedf Binary files /dev/null and b/docs/screenshots/equity.png differ diff --git a/docs/screenshots/journal.png b/docs/screenshots/journal.png new file mode 100644 index 0000000..bfde360 Binary files /dev/null and b/docs/screenshots/journal.png differ diff --git a/docs/screenshots/pnl.png b/docs/screenshots/pnl.png new file mode 100644 index 0000000..91165c7 Binary files /dev/null and b/docs/screenshots/pnl.png differ