git.iko.soy/monoidal-containers
on master help sign in
Clarify vision for library

cf #50

commitb058556ea31b415fdbcc72e65826d62e27a7c56b authorElliot Cameron <3noch@users.noreply.github.com> dateSat 24 Aug 2019, 17:40 (7 years ago) parent1194da8
1 file changed+4
README.md+4
README.md+4
@@ -6,3 +6,7 @@ of the values to be used when resolving conflicts between keys when merging
66structures. Sadly, these are not the semantics offered by the provided
77instances. This package provides `newtypes` with an appropriate set of
88instances and utility functions to make them usable.
9+
10+## Important Note
11+
12+This library is desinged to be a drop-in replacement for `Data.Map` and similar. Absolutely no other semantic changes are introduced in functions like `fromList` or `insert`. They are still left-biased like `Data.Map`'s. The only difference is in instances for `Semigroup`.