git ssb

0+

Rômulo Alves / money-block



Tree: ecf6563965cf3a734a59dfba74cd29977efbe9d6

Files: ecf6563965cf3a734a59dfba74cd29977efbe9d6 / README.md

1136 bytesRaw

money-block

Take notes of your earnings and expenses and process them over money-block to calculate everything for you

Symbols

$: balance - Auto generated, shows your general balance

|: group - Represents an account or card, like savings or some credit card

|- other group - This represents groups as |, except that they won't be added to the general balance

+: earning - Any more your received

-: expense - Money you wasted

=: total - Auto generated, balance of a group

Examples

With one group

If you write this:

| savings account
+ 123 first deposit
+ 111 second deposit

money-block would return:

$ 234

| savings account
+ 123 first deposit
+ 111 second deposit
= 234

How to use

const moneyBlockProcess = require('money-block');

const myMoneyNotes = `
| savings account
+ 123 first deposit
+ 111 second deposit
`;

console.log(moneyBlockProcess(myMoneyNotes));
/* OUTPUT:
$ 234

| savings account
+ 123 first deposit
+ 111 second deposit
= 234

*/

Testing

With npm

npm install
npm test

With yarn

yarn install
yarn test

Built with git-ssb-web