on master help sign in
Add README
commita40bf7777ca137a4baf0abb856986ed05129ee0c authorNick <nick@typeable.io> dateMon 28 Nov 2022, 11:57 (4 years ago) parent871cbf3
1 file changed+25
README.org+25
README.orgnew file+25
@@ -0,0 +1,25 @@
1+#+title: Bucks library README
2+#+author: Me, who else?
3+
4+* What is even going on here?
5+
6+Bucks is a new and shiny money handling library. I made it, because we have five
7+different 'Money' type implementations and they are all slightly different from
8+each other. Therefore, making a new one and pulling the best parts of those old
9+makes a whole lot more sense!
10+
11+* But how do I use it?
12+
13+Add 'bucks' to your .cabal file and maybe to your stack.yaml as well. You're a
14+big boy, you know the drill.
15+
16+* Features
17+
18+Things that require chonky third-party dependencies are hidden behind flags.
19+Want aeson instances? Enable the flag. Want Rel8 for your database shenanigans?
20+Enable the flag! Want something else? Add that thing, make a flag for it, and
21+don't forget to have fun!
22+
23+* You forgot feature X..
24+
25+And you're welcome to add it :)