Skip to content

Commit

Permalink
docs: use more cli flags
Browse files Browse the repository at this point in the history
Co-authored-by: Shahar Dawn Or <[email protected]>
Co-authored-by: Alexander Nitiola <[email protected]>
  • Loading branch information
3 people committed Sep 4, 2022
1 parent 68170e9 commit 9fd965c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ It is intended that any release will be able to read persistance data from any e
Create an _initial balance_ account where all initial balances originate.

```console
$ budgeteer account create external "initial balance"
$ budgeteer account create --kind external --name "initial balance"
```

Create some budget accounts.

```console
$ budgeteer account create budget wallet
$ budgeteer account create budget bank
$ budgeteer account create --kind budget --name wallet
$ budgeteer account create --kind budget --name bank
```

Record a transaction that will explain your current balances.
Expand All @@ -39,14 +39,18 @@ Recorded transaction #1
Create a currency unit.

```console
$ budgeteer unit create USD 2
$ budgeteer unit create --decimal-places 2 --name USD
```

Add moves to that transaction.

```console
$ budgeteer move add 1 "initial balance" wallet 147.13 USD
$ budgeteer move add 1 "initial balance" bank 5650.3 USD
$ budgeteer move add --transaction 1
> --debit-account "initial balance" --credit-account wallet
> --amount 147.13 --unit USD
$ budgeteer move add --transaction 1
> --debit-account "initial balance" --credit-account bank
> --amount 5650.3 --unit USD
```

Show current balances.
Expand All @@ -62,10 +66,12 @@ wallet 147.13 USD
Pay rent.

```console
$ budgeteer account create external rent
$ budgeteer account create --kind external --name rent
$ budgeteer transaction record --date 2022-08-28
Recorded transaction #2
$ budgeteer move add 2 bank rent 1200 USD
$ budgeteer move add --transaction 2
> --debit-account bank --credit-account rent
> --amount 1200 --unit USD
```

Show the running balance of the bank account.
Expand Down
Binary file added core.14042
Binary file not shown.

0 comments on commit 9fd965c

Please sign in to comment.