Skip to content

Commit aa83414

Browse files
Merge pull request #36 from purescript-contrib/thomashoneyman-patch-1
Update README with general Argonaut information
2 parents 50a0af2 + 4950903 commit aa83414

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,28 @@
66
[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-lightgrey.svg)](http://github.com/garyb)
77
[![Maintainer: thomashoneyman](https://img.shields.io/badge/maintainer-thomashoneyman-lightgrey.svg)](http://github.com/thomashoneyman)
88

9-
Core part of `purescript-argonaut` that contains basic types for `Json`, case analysis, printer and parser.
9+
[Argonaut](https://github.com/purescript-contrib/purescript-argonaut) is a collection of libraries for working with JSON in PureScript. `argonaut-core` defines the core `Json` type, along with basic parsing, printing, and folding functions which operate on it.
1010

1111
## Installation
1212

13-
```shell
13+
This library is bundled as part of [Argonaut](https://github.com/purescript-contrib/purescript-argonaut) and can be installed via that library. To install just `argonaut-core`:
14+
15+
```sh
16+
# with Spago
17+
spago install argonaut-core
18+
19+
# with Bower
1420
bower install purescript-argonaut-core
1521
```
1622

1723
## Documentation
1824

19-
Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-argonaut-core).
25+
Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-argonaut-core). You may also be interested in other libraries in the Argonaut ecosystem:
26+
27+
- [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.
28+
- [purescript-codec-argonaut](https://github.com/garyb/purescript-codec-argonaut) supports an alternative approach for codecs, which are based on profunctors instead of type classes.
29+
- [purescript-argonaut-traversals](https://github.com/purescript-contrib/purescript-argonaut-traversals) defines prisms, traversals, and zippers for the `Json` type.
30+
- [purescript-argonaut-generic](https://github.com/purescript-contrib/purescript-argonaut-generic) supports generic encoding and decoding for any type with a `Generic` instance.
2031

2132
## Tutorial
2233

0 commit comments

Comments
 (0)