Skip to content

Commit b05d14e

Browse files
committed
docs: add short resource explanations
1 parent 06a592d commit b05d14e

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

docs/usage.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
11
# Usage
22

3+
## Resources
4+
5+
### Budget
6+
7+
A budget might represent your own personal budget, the budget of your flat share or any other budget that you want to track.
8+
9+
### Account
10+
11+
An account represents an account as an accountant would use it. For example, cash in your wallet, an actual bank account, a credit card are all distinct accounts.
12+
Every other person or company you pay money to also is tracked as an account. This allows for detailed accounting of how much spending occurs towards e.g. a specific supermarket.
13+
14+
### Category
15+
16+
A category is a grouping of envelopes for similar purposes. You might for example want to group envelopes for different saving goals like a new couch, the next vacation etc. in a category called “Saving“.
17+
18+
### Envelope
19+
20+
The key of the budget. Each envelope tracks budget for one specific purpose, e.g. groceries. Any transaction you make for groceries gets linked to this envelope, allowing you to track how much you spent on groceries in a month.
21+
22+
If you do not spend all of the allocated budget, it rolls over to the next month. This allows to allocate a budget for expenses that do not occur that often. Say you have an insurance that is billed yearly for 120€. In this case, you can budget 10€ per month for this insurance. Once the bill arrives, all the needed budget is already allocated.
23+
24+
### Transaction
25+
26+
A transaction represents an actual transaction. Paying for groceries, getting paid your salary, gifting somebody money for their wedding, all of those are transactions. Every transaction must be tied to a source account and destination account.
27+
28+
All transactions that are not income should be tied to an envelope so that you can see what you spend money for.
29+
30+
### Allocation
31+
32+
An allocation is the database representation of the sum that is budgeted for a month for a specific envelope.
33+
334
## Deleting resources
435

536
Envelope Zero soft deletes almost all resources, so you will be able to restore them.

0 commit comments

Comments
 (0)