mirror of
https://github.com/typeable/bucks.git
synced 2024-09-11 15:16:20 +03:00
Add README
This commit is contained in:
parent
871cbf3835
commit
a40bf7777c
25
README.org
Normal file
25
README.org
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
#+title: Bucks library README
|
||||||
|
#+author: Me, who else?
|
||||||
|
|
||||||
|
* What is even going on here?
|
||||||
|
|
||||||
|
Bucks is a new and shiny money handling library. I made it, because we have five
|
||||||
|
different 'Money' type implementations and they are all slightly different from
|
||||||
|
each other. Therefore, making a new one and pulling the best parts of those old
|
||||||
|
makes a whole lot more sense!
|
||||||
|
|
||||||
|
* But how do I use it?
|
||||||
|
|
||||||
|
Add 'bucks' to your .cabal file and maybe to your stack.yaml as well. You're a
|
||||||
|
big boy, you know the drill.
|
||||||
|
|
||||||
|
* Features
|
||||||
|
|
||||||
|
Things that require chonky third-party dependencies are hidden behind flags.
|
||||||
|
Want aeson instances? Enable the flag. Want Rel8 for your database shenanigans?
|
||||||
|
Enable the flag! Want something else? Add that thing, make a flag for it, and
|
||||||
|
don't forget to have fun!
|
||||||
|
|
||||||
|
* You forgot feature X..
|
||||||
|
|
||||||
|
And you're welcome to add it :)
|
Loading…
Reference in New Issue
Block a user