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.

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

Change project description #37

Closed
BurtHarris opened this issue Jun 6, 2017 · 4 comments
Closed

Change project description #37

BurtHarris opened this issue Jun 6, 2017 · 4 comments

Comments

@BurtHarris
Copy link
Contributor

As I understand it, this is some sort of converter between async model conventions, but I'm unclear when I'd use it. I suggest a small scenario section at the top of the README might help clarify.

@BurtHarris
Copy link
Contributor Author

BurtHarris commented Jun 6, 2017

Reading this portion of the bach docs help me understand:

Functions are called with async-done, so you can return a stream, promise, observable or child process

Sounds very cool...

@BurtHarris BurtHarris changed the title doc use-case/scenario for use doc use-case/scenario Jun 6, 2017
@phated
Copy link
Member

phated commented Jun 6, 2017

This uses the standard gulpjs org readme template.

This project has too many applications to be shoehorned into "use in this scenario". Bach is just one application of this and many npm packages use it in their own way.

@phated phated closed this as completed Jun 6, 2017
@BurtHarris
Copy link
Contributor Author

BurtHarris commented Jun 6, 2017

I'm not suggesting changing the template @phated, just saying that the current tagline isn't very descriptive. Perhaps it should be something more like:

Allows libraries to handle various caller provided asynchronous functions uniformly. Maps promises, observables, child processes and streams, and callbacks to callback style.

@phated phated changed the title doc use-case/scenario Change project description Jun 6, 2017
@phated phated reopened this Jun 6, 2017
@phated
Copy link
Member

phated commented Jun 6, 2017

I'd be open to changing the project description. Please send a PR to further discuss. I've changed the title and reopened this.

BurtHarris pushed a commit to BurtHarris/async-done that referenced this issue Jun 6, 2017
BurtHarris pushed a commit to BurtHarris/async-done that referenced this issue Jun 6, 2017
@phated phated closed this as completed in #39 Jun 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants