argonaut

PureScript implementation of argonaut


License
MIT
Install
psc-package install argonaut

Documentation

Argonaut

CI Release Pursuit Maintainer: garyb Maintainer: thomashoneyman

Argonaut is a collection of libraries for working with JSON in PureScript. This library bundles together the following:

Installation

Install argonaut with Spago:

spago install argonaut

You can also install Argonaut libraries individually (for example, by only installing argonaut-core for the Json type).

Quick start

This library bundles together several other libraries. We recommend checking out the quick starts for those libraries depending on which use case you're looking for:

Documentation

argonaut documentation is stored in a few places:

  1. Module documentation is published on Pursuit.
  2. Written documentation is kept in the docs directory.
  3. Usage examples can be found in the test suite.

If you get stuck, there are several ways to get help:

Contributing

You can contribute to argonaut in several ways:

  1. If you encounter a problem or have a question, please open an issue. We'll do our best to work with you to resolve or answer it.

  2. If you would like to contribute code, tests, or documentation, please read the contributor guide. It's a short, helpful introduction to contributing to this library, including development instructions.

  3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the PureScript Discourse! Writing libraries and learning resources are a great way to help this library succeed.