Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #206

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #206

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8008603
Update README.md
jamesdbrock Nov 6, 2021
bf7310e
Update README.md
jamesdbrock Nov 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@

An asynchronous effect monad and threading model for PureScript.

`aff` is in the same space as JavaScript Promises, but with additional support for cancellation (async exceptions) and resource management (`bracket`). It provides cooperative multi-tasking which yields on async constructors (`makeAff`).

For OS-thread parallelism in Node.js, see [node-workerbees](https://github.com/natefaubion/purescript-node-workerbees).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since node-workerbees is experimental, I’m not sure we should link it here. What do you think?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a strong opinion about that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a Related Packages section further down in the README?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably put this in related packages too: https://pursuit.purescript.org/packages/purescript-avar/4.0.0


## Installation

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