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

Jump to bottom

Needs a quick start section in the README #12

Open
thomashoneyman opened this issue Oct 6, 2020 · 2 comments
Open

Needs a quick start section in the README #12

thomashoneyman opened this issue Oct 6, 2020 · 2 comments
Labels
good first issue First-time contributors who are looking to help should work on these issues. type: documentation Improvements or additions to documentation.

Comments

@thomashoneyman
Copy link
Contributor

Is your change request related to a problem? Please describe.
As described in the documentation section of the Library Guidelines, Contributors libraries are expected to have in their README a short summary of the library's purpose, installation instructions, a quick start with a minimal usage example, and links to the documentation and contributing guide.

This library currently doesn't have a completed quick start in the README.

Describe the solution you'd like
The library needs a quick start section after the installation instructions. machines is a good example of a small, to-the-point quick start.

We could at least demonstrate a minimal example which uses suspend, fork, join, and kill.

Additional context
See the Governance repository for more information about requirements in the Contributors organization.
@thomashoneyman thomashoneyman added help wanted type: documentation Improvements or additions to documentation. good first issue First-time contributors who are looking to help should work on these issues. labels Oct 6, 2020
@thomashoneyman
Copy link
Contributor Author

The library summary could also stand to improve -- when should you reach for this library? What are some example monads with instances? I'm only aware of Aff.

@natefaubion
Copy link
Collaborator

It essentially lets you write generic concurrency code for either Aff or things that are equivalent to ReaderT e Aff a.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue First-time contributors who are looking to help should work on these issues. type: documentation Improvements or additions to documentation.
Milestone
No milestone
Development

No branches or pull requests
3 participants
@natefaubion @JordanMartinez @thomashoneyman