From 001dcf7d73148ffe13fd5f6bffda43d78d5718e1 Mon Sep 17 00:00:00 2001 From: Peter Becich Date: Wed, 3 Jan 2024 00:09:47 -0800 Subject: [PATCH] readme --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2ceb6eb5..ab5b84a5 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,54 @@ For compatible JSON representations: * Use [`aeson`](http://hackage.haskell.org/package/aeson)'s generic encoding/decoding with default options * On Purescript side: * Use [`purescript-argonaut-aeson-generic >=0.4.1`](https://pursuit.purescript.org/packages/purescript-argonaut-aeson-generic/0.4.1) ([GitHub](https://github.com/coot/purescript-argonaut-aeson-generic)) - * Or use [`purescript-foreign-generic`](https://pursuit.purescript.org/packages/purescript-foreign-generic). - * [This branch](https://github.com/paf31/purescript-foreign-generic/pull/76) is updated for Purescript 0.15. + * additionally required [peterbecich/purescript-argonaut-codecs](https://github.com/peterbecich/purescript-argonaut-codecs.git) + * commit `04abb3eb24a4deafe125be0eb23e2786c642e66b` + * sample Dhall config: + ``` + , argonaut-codecs = + { dependencies = [ "console" ] + , repo = "https://github.com/peterbecich/purescript-argonaut-codecs.git" + , version = "04abb3eb24a4deafe125be0eb23e2786c642e66b" + } + ``` + * forked from [purescript-contrib/purescript-argonaut-codecs](https://github.com/purescript-contrib/purescript-argonaut-codecs) + * *or* [input-output-hk/purescript-bridge-json-helpers](https://github.com/input-output-hk/purescript-bridge-json-helpers.git) + * commit `60615c36abaee16d8dbe09cdd0e772e6d523d024` + * sample Dhall config: + ``` + , json-helpers = + { dependencies = + [ "aff" + , "argonaut-codecs" + , "argonaut-core" + , "arrays" + , "bifunctors" + , "contravariant" + , "control" + , "effect" + , "either" + , "enums" + , "foldable-traversable" + , "foreign-object" + , "maybe" + , "newtype" + , "ordered-collections" + , "prelude" + , "profunctor" + , "psci-support" + , "quickcheck" + , "record" + , "spec" + , "spec-quickcheck" + , "transformers" + , "tuples" + , "typelevel-prelude" + ] + , repo = + "https://github.com/input-output-hk/purescript-bridge-json-helpers.git" + , version = "60615c36abaee16d8dbe09cdd0e772e6d523d024" + } + ``` ## Documentation