# 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

```javascript
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
```

## License

MIT License

Copyright (c) 2021 Rômulo Alves

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.