search

reazen / relude-eon

A datetime library for the ages in ReasonML
MIT License
12 stars 4 forks source link

Make it more clear how to get started #13

Closed edouardmenayde closed 4 years ago

edouardmenayde commented 4 years ago

I suggest to make it more obvious you need relude and bs-abstract. I'm a newbie and spent quite some time figuring out why compilation would not work because I did not have relude has a dependency. It's clearly a noob problem but if power users for some reason do not need one of the peerDependency because they do not use any function that uses it they can figure out themselves not the other way around in my opinion.

mlms13 commented 4 years ago

We use peerDependencies so that end-users of the library have full control over dependency versions (otherwise you can end up with duplicates and Bucklescript gets confused).

In reality, relude and bs-abstract (oh oh, we should update that to bs-bastet) are proper dependencies, used by relude-eon itself, so I think your change makes things much more clear, thanks!

mlms13 commented 4 years ago

I just further updated the Readme to use Bastet instead of bs-abstract... you'll probably want to do the same in your project @edouardmenayde. Sorry for the getting-started confusion, and thanks for helping to make it more clear!

edouardmenayde commented 4 years ago

Perfect 😄