https://github.com/purescript-contrib/purescript-fork

An MTL-style class for monads that support forking
https://github.com/purescript-contrib/purescript-fork

Last synced: 14 days ago
JSON representation

An MTL-style class for monads that support forking

• Host: GitHub
• URL: https://github.com/purescript-contrib/purescript-fork
• Owner: purescript-contrib
• License: apache-2.0
• Created: 2016-11-19T20:38:22.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-05-10T09:54:38.000Z (almost 3 years ago)
• Last Synced: 2025-02-11T21:38:36.551Z (about 1 year ago)
• Language: PureScript
• Homepage:
• Size: 39.1 KB
• Stars: 7
• Watchers: 12
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Fork

[![CI](https://github.com/purescript-contrib/purescript-fork/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-fork/actions?query=workflow%3ACI+branch%3Amain)

[![Release](https://img.shields.io/github/release/purescript-contrib/purescript-fork.svg)](https://github.com/purescript-contrib/purescript-fork/releases)

[![Pursuit](https://pursuit.purescript.org/packages/purescript-fork/badge)](https://pursuit.purescript.org/packages/purescript-fork)

[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-teal.svg)](https://github.com/garyb)

Monads which support a forking operation.

## Installation

Install `fork` with [Spago](https://github.com/purescript/spago):

```sh

spago install fork

```

## 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](./docs).

## Documentation

`fork` documentation is stored in a few places:

1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-fork).

2. Written documentation is kept in the [docs directory](./docs).

3. Usage examples can be found in [the test suite](./test).

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

- [Open an issue](https://github.com/purescript-contrib/purescript-fork/issues) if you have encountered a bug or problem.

- Ask general questions on the [PureScript Discourse](https://discourse.purescript.org) forum or the [PureScript Discord](https://purescript.org/chat) chat.

## Contributing

You can contribute to `fork` in several ways:

1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-fork/issues). 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](./CONTRIBUTING.md). 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](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.