|
6 | 6 | [](http://github.com/garyb)
|
7 | 7 | [](http://github.com/thomashoneyman)
|
8 | 8 |
|
9 |
| -Go to [purescript-argonaut-core/README.md](https://github.com/purescript-contrib/purescript-argonaut-core/blob/master/README.md) to read an overview of Argonaut and how to use it. |
| 9 | +[Argonaut](https://github.com/purescript-contrib/purescript-argonaut) is a collection of libraries for working with JSON in PureScript. This library bundles together the following: |
10 | 10 |
|
11 |
| -This library bundles together the following: |
| 11 | +- [purescript-argonaut-core](https://github.com/purescript-contrib/purescript-argonaut-core) provides basic parsing, printing, folding and types for `Json`. |
| 12 | +- [purescript-argonaut-codecs](https://github.com/purescript-contrib/purescript-argonaut-codecs) provides codecs based on `EncodeJson` and `DecodeJson` type classes (along with instances for common data types) and combinators for encoding and decoding `Json` values. |
| 13 | +- [purescript-argonaut-traversals](https://github.com/purescript-contrib/purescript-argonaut-traversals) defines prisms, traversals, zippers, and `JCursor` for the `Json` type. |
| 14 | + |
| 15 | +## Installation |
| 16 | + |
| 17 | +```sh |
| 18 | +# with Spago |
| 19 | +spago install argonaut |
| 20 | + |
| 21 | +# with Bower |
| 22 | +bower install purescript-argonaut |
| 23 | +``` |
| 24 | + |
| 25 | +## Documentation |
| 26 | + |
| 27 | +Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-argonaut). |
| 28 | + |
| 29 | +- To learn more about Argonaut, its basic data types, and its approach to JSON, see [purescript-argonaut-core](https://github.com/purescript-contrib/purescript-argonaut-core). |
| 30 | +- To learn more about encoding and decoding PureScript types to and from `Json`, see [purescript-argonaut-codecs](https://github.com/purescript-contrib/purescript-argonaut-codecs). |
| 31 | +- To learn more about manipulating `Json` using optics and `JCursor`, see [purescript-argonaut-traversals](https://github.com/purescript-contrib/purescript-argonaut-traversals) |
12 | 32 |
|
13 |
| -- [purescript-argonaut-core](https://github.com/purescript-contrib/purescript-argonaut-core) - basic parsing, printing, folding and types for `Json` |
14 |
| -- [purescript-argonaut-codecs](https://github.com/purescript-contrib/purescript-argonaut-codecs) - `EncodeJson` and `DecodeJson` classes, their instances, and helper functions |
15 |
| -- [purescript-argonaut-traversals](https://github.com/purescript-contrib/purescript-argonaut-traversals) - `JCursor`, prisms and traversals for `Json` |
16 | 33 |
|
17 | 34 | ## Contributing
|
18 | 35 |
|
|
0 commit comments