Merge pull request #51 from 3noch/patch-1
Clarify vision for library
commit07cd41735f44f54608792878582369735e1babbc
authorAli Abrar <aliabrar@gmail.com>
dateTue 27 Aug 2019, 16:30 (7 years ago)
parent1194da8816078a
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 designed 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`.