Please add docs to describe the idea of the concepts

[rethab]

Hi @FabioPinheiro :) Could you please add some docs about what eg. MoneyTree is used for? Or what the idea of having money in a tree is? Also, I see there are some MoneyK and MoneyX things. What do these suffixes stand for?

Thanks and Congrats to making the Money library happen 👍

[FabioPinheiro]

Hey, Reto :D Thanks for your comment!
I will add more documentation about the goals.

The initial idea was for the MoneyTree to be able to handle multiple instances of Money (in different currencies). Each instance of Money has one currency and one value.
The suffixes on MoneyX, MoneyY and MoneyK does not stand for anything in specific. Those have different properties and implementations. I wanted to have only one at the end.

I wanted to be easy and simple to use as a Double with some imports. But everything must be type-safe, with the exception of one method. The method that allowed converting MoneyTree to Money when you have only a subset of conversion rates.
Traceability is one of the things that I wanted to be easy to have on top of MoneyTree.

I think I will have a lot of free time next month and I will get back to my ped projects.
It would be awesome if this ends up being useful for other people.

[FabioPinheiro]

It's a WIP (like everything here). But it now has a documentation website.
https://fabiopinheiro.github.io/cats-money

[rethab]

Looks nice! And also nice logo 😄 I'm still a bit puzzled as to what the use-case for MoneyTree is though. Could you please give me an example use case where you'd use this?