Skip to content

Commit 78aeb47

Browse files
Update README with general Argonaut information
1 parent 50a0af2 commit 78aeb47

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,31 @@
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+
10+
[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.
1011

1112
## Installation
1213

13-
```shell
14+
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`:
15+
16+
```sh
17+
# with Spago
18+
spago install argonaut-core
19+
20+
# with Bower
1421
bower install purescript-argonaut-core
1522
```
1623

1724
## Documentation
1825

19-
Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-argonaut-core).
26+
Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-argonaut-core).
27+
28+
You may also be interested in other libraries in the Argonaut ecosystem:
29+
30+
- [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.
31+
- [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.
32+
- [purescript-argonaut-traversals](https://github.com/purescript-contrib/purescript-argonaut-traversals) defines prisms, traversals, and zippers for the `Json` type.
33+
- [purescript-argonaut-generic](https://github.com/purescript-contrib/purescript-argonaut-generic) supports generic encoding and decoding for any type with a `Generic` instance.
2034

2135
## Tutorial
2236

0 commit comments

Comments
 (0)