diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +# 0.4.4.3 + +* Fixed markup in the .cabal file. +* Added descriptions of other packages to `Lens.Micro`. + # 0.4.4.2 * More changes to make microlens-platform more prominent. diff --git a/microlens.cabal b/microlens.cabal --- a/microlens.cabal +++ b/microlens.cabal @@ -1,10 +1,10 @@ name: microlens -version: 0.4.4.2 +version: 0.4.4.3 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. + NOTE: 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'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!). + This library 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. . 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. . @@ -28,7 +28,7 @@ . 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 depends 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 diff --git a/src/Lens/Micro.hs b/src/Lens/Micro.hs --- a/src/Lens/Micro.hs +++ b/src/Lens/Micro.hs @@ -14,6 +14,19 @@ Module : Lens.Micro Copyright : (C) 2013-2016 Edward Kmett, 2015-2016 Artyom License : BSD-style (see the file LICENSE) + +This module provides the essential functionality. There are other packages in the microlens family – mix and match them at will. If you're writing an app, you want – it provides the most functionality. + +* – (@+=@) and friends, @use@, @zoom@\/@magnify@ +* – @makeLenses@ and @makeFields@ +* – everything in microlens + instances to make @each@\/@at@\/@ix@ usable with arrays, @ByteString@, and containers +* – microlens-ghc + microlens-mtl + microlens-th + instances for @Text@, @Vector@, and @HashMap@ +* – @Fold@ and @Getter@ that are exact copies of types in lens + +Unofficial: + +* – a port of + -} module Lens.Micro (