Package

purescript-uri

Repository
purescript-contrib/purescript-uri
License
Apache-2.0
Uploaded by
thomashoneyman
Published on
2021-05-06T16:56:41Z

CI Release Pursuit Maintainer: garyb

A type-safe parser, printer, and ADT for URLs and URIs based on RFC 3986.

Installation

Install uri with Spago:

spago install uri

Quick start

The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the docs directory.

Documentation

uri 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 uri 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.