thunderstrike/purescript-unlift
thunderstrike/purescript-unlift
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Write README

Browse Source
This commit is contained in:
Jamie Bertram 2022-03-15 10:47:52 -06:00
parent 878af237f4
commit f80992d691
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,3 +1,26 @@
# purescript-unlift
MonadBase, MonadUnlift, MonadUnliftEffect, and MonadUnliftAff
[![Latest release](http://img.shields.io/github/release/purescript/purescript-unlift.svg)](https://github.com/purescript/purescript-unlift/releases)
[![Build status](https://github.com/purescript/purescript-unlift/workflows/CI/badge.svg?branch=main)](https://github.com/purescript/purescript-unlift/actions?query=workflow%3ACI+branch%3Amain)
[![Pursuit](https://pursuit.purescript.org/packages/purescript-unlift/badge)](https://pursuit.purescript.org/packages/purescript-unlift)
Standard library for working with monads at the base of a transformer stack.
`MonadBase` allow any base monad to be lifted into a transformed monad à la
`MonadEffect` and `MonadAff`. `MonadUnliftEffect`, `MonadUnliftAff`, and
`MonadUnlift` allow running a stateless transformed monad inside of a base
monad. Based on:
- [transformers-base](http://hackage.haskell.org/package/transformers-base)
- [unliftio](http://hackage.haskell.org/package/unliftio)
- [unlift](http://hackage.haskell.org/package/unlift)
## Installation
```
spago install unlift
```
## Documentation
Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-unlift).