search

garyb / purescript-codec

General purpose bi-directional codecs
MIT License
16 stars 5 forks source link

Usage instructions #13

Open alphashuro opened 3 days ago

alphashuro commented 3 days ago

How is this meant to be used? A description or example would be great to add to the docs or README.

garyb commented 3 days ago

It's not really meant to be used as-is, but rather as a base point to build other stuff on top of, but yeah it is lacking in documentation. I'm not too sure how to approach it really as it is very abstract.

https://github.com/garyb/purescript-codec-argonaut and https://github.com/garyb/purescript-codec-json are built on it (both libraries are very similar, just a differently underlying type, with json being the newer type).