From bb538f0309cda4c1f0ea1a379a3fa088853a5518 Mon Sep 17 00:00:00 2001 From: Ross MacLeod Date: Tue, 10 Aug 2021 19:39:42 -0400 Subject: [PATCH] update list of libraries, add external ones too --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 31b591a..093bcf6 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,29 @@ aliceJson :: Aeson.Value aliceJson = toJsonWithFormat userFormat alice ``` +### `composite-aeson-path` + +`composite-aeson` support for the [path](https://hackage.haskell.org/package/path) library. + +### `composite-aeson-refined` + +`composite-aeson` support for the [refined](https://hackage.haskell.org/package/refined) library. + ### `composite-base` -Definitions shared by the other composite libraries or generally useful when using Vinyl records. +Definitions shared by the other composite libraries or generally useful when using Vinyl records. Includes some Template Haskell splices to generate various optics for records, as well as a specialization of `MonadReader` which works on a context record, providing general environment for a computation. + +### `composite-binary` + +Instance of `Binary` from the [binary](https://hackage.haskell.org/package/binary) library for composite records. + +### `composite-ekg` + +Autoconfiguration of [EKG](https://hackage.haskell.org/package/ekg) from a record of EKG metrics. + +### `composite-hashable` + +Instance of `Hashable` from the [hashable](https://hackage.haskell.org/package/hashable) library for composite records. ### `composite-opaleye` @@ -78,6 +98,17 @@ userQuery = returnA -< user ``` +### `composite-swagger` + +Automatic derivation of Swagger 2 (ala [swagger2](https://hackage.haskell.org/package/swagger2)) definitions for composite records. + +### Related work + +- [`compdoc`](https://hackage.haskell.org/package/compdoc) provides functionality for reading a Pandoc into a record. +- [`composite-dhall`](https://hackage.haskell.org/package/composite-dhall) provides `ToDhall` and `FromDhall` instances for composite records. +- [`composite-tuple`](https://hackage.haskell.org/package/composite-tuple) provides utility functions for treating composite records as tuples, ala `Relude.Extra.Tuple` from [relude](https://hackage.haskell.org/package/relude). +- [`polysemy-methodology-composite`](https://hackage.haskell.org/package/polysemy-methodology-composite) provides functions for using polysemy-methodology with composite. + ### `example` A small servant based server which uses `composite-opaleye` to pull records from the database, reshape