diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +# 0.4.4.2 + +* More changes to make microlens-platform more prominent. + # 0.4.4.1 * Pointed to microlens-platform in the synopsis. diff --git a/microlens.cabal b/microlens.cabal --- a/microlens.cabal +++ b/microlens.cabal @@ -1,30 +1,34 @@ name: microlens -version: 0.4.4.1 +version: 0.4.4.2 synopsis: A tiny lens library with no dependencies. If you're writing an app, you probably want microlens-platform, not this. description: This is an extract from (with no dependencies). It's not a toy lenses library, unsuitable for “real world”, but merely a small one. It is compatible with lens, and should have same performance. It also has better documentation. . - Use this library: + __If you're writing an app, you probably want – it has the most features.__ is intended more for library writers who want a tiny lens library (after all, lenses are pretty useful for everything, not just for updating records!). . - * if you want to define lenses or traversals in your own library, but don't want to depend on lens + There's a longer readme . It has a migration guide for lens users, a description of other packages in the family, a discussion of other lens libraries you could use instead, and so on. . - * if you are new to lenses and want a small library to play with, but don't want to use something “inferior” or have to relearn things when/if you switch to lens + Here are some usecases for this library: . - Don't use this library: + * You want to define lenses or traversals in your own library, but don't want to depend on lens. Having lenses available often make working with a library more pleasant. . - * if you need @Iso@s, @Prism@s, indexed traversals, or actually anything else which isn't defined here (tho some indexed functions are available elsewhere – containers and vector provide them for their types, and provides indexed functions for lists) + * You just want to be able to use lenses to transform data (or even just use @over _1@ to change the first element of a tuple). . - * if you want a library with a clean, understandable implementation (in which case you're looking for ) + * You are new to lenses and want a small library to play with. . - If you're writing an application which uses lenses more extensively, look at – it combines features of most other microlens packages (, , ). + However, don't use this library if: . - If you want to export getters or folds and don't mind the dependency, please consider using . + * You need @Iso@s, @Prism@s, indexed traversals, or actually anything else which isn't defined here (tho some indexed functions are available elsewhere – containers and vector provide them for their types, and provides indexed functions for lists). . - There's a longer readme , you should read it if you're interested about using this library. + * You want a library with a clean, understandable implementation (in which case you're looking for ). . + As already mentioned, if you're writing an application which uses lenses more extensively, look at – it combines features of most other microlens packages (, , ). + . + If you want to export getters or folds and don't mind the dependency, please consider using . + . If you haven't ever used lenses before, read . (It's for lens, but it applies to microlens just as well.) . - Note that microlens has /no/ dependencies starting from GHC 7.10 (base-4.8). Prior to that, it has to depend on transformers-0.2 or above. + Note that microlens has /no/ dependencies starting from GHC 7.10 (base-4.8). Prior to that, it depends on transformers-0.2 or above. license: BSD3 license-file: LICENSE author: Edward Kmett, Artyom