search

hiddewie / money-kotlin

Kotlin extensions for javax.money (Moneta) JSR 354
Apache License 2.0
28 stars 2 forks source link

Please update the readme to make aware all the libraries one has to use to follow the instructions #2

Closed lennykey closed 1 year ago

lennykey commented 1 year ago

// Create a monetary amount of a specific type and currency

val money = (10.0).ofCurrency<FastMoney>("EUR")

The example shown in the README can not be used out of the box. I also had to include e.g. implementation("org.javamoney:moneta-bp:1.4.1") to make it work.

First I was confused if I am making something wrong. Could you please clarify what is needed to use the extensions in this library or even better provide all the needed libraries within your library

hiddewie commented 1 year ago

It is mentioned in the readme:

This code builds upon the Money API of the JSR proposal, not the Moneta classes in the reference implementation.

So this library only adds methods on top of the API, and does not depend on a specific implementation. If you like to use a specific implementation, such as the reference implementation Moneta, you may of course use this by adding the implementation as a dependency.

I will make this a bit more clear in the readme.