Skip to content

Commit

Permalink
more readme
Browse files Browse the repository at this point in the history
  • Loading branch information
darcys22 committed Feb 16, 2020
1 parent 6d52394 commit 7d7fb65
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,17 @@ An [example project](https://github.com/darcys22/Trading-Simulator) has been dev
**Reporter**
The general usage of Godbledger is not to provide information but to simply guide transactions to be recorded in a consistent manner in the database. To actually view your financial information we should query the database directly. Reporter has two SQL queries in built (Transaction Listing, and Trial Balance) that will be formatted in a table/json/csv for your viewing.

```
reporter trialbalance
```

**PDF Financial Statements**
Reporter also has a function to generate pdf financial reports. Two templates for Profit and Loss and Balance sheet have been provided.

```
reporter pdf -template profitandloss
```

The PDF files are generated from [handlebars](https://handlebarsjs.com/) iterating over the tagged accounts. This is compiled into PDF using nodejs.

templates can be viewed [here](https://github.com/darcys22/pdf-generator)
Expand Down

0 comments on commit 7d7fb65

Please sign in to comment.