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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the readme usage examples #385

Merged
merged 3 commits into from Nov 3, 2019
Merged

Improve the readme usage examples #385

merged 3 commits into from Nov 3, 2019

Conversation

justsml
Copy link
Contributor

@justsml justsml commented Nov 1, 2019

Thanks Sindre for this amazing library!!!

  • Used comments to label examples w/ headers in markdown.
  • Added a promise example to help a more diverse set of users.

I live-coded this in the spirit of Hacktoberfest!

My goal was to become youtube famous https://youtu.be/z7svdNlAJpY ...

And help with your readme 馃槆

@sindresorhus
Copy link
Owner

Thanks for helping us improve the readme 馃檶

@sindresorhus
Copy link
Owner

Added a promise example to help a more diverse set of users.

I've removed this. We're not gonna document JavaScript features. It's expected for users to know/learn async/await.

@justsml
Copy link
Contributor Author

justsml commented Nov 1, 2019

That's fair enough. 馃憤

Really appreciate all your work for the community 鉂わ笍

@sindresorhus sindresorhus changed the title Cleanup examples in readme.md Improve the readme usage examples Nov 1, 2019
ehmicky
ehmicky approved these changes Nov 1, 2019
View reviewed changes
Copy link
Collaborator

@ehmicky ehmicky left a comment

Choose a reason for hiding this comment

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

Thanks a lot for this PR @justsml. This looks good to me!

readme.md Outdated
const execa = require('execa');

(async () => {
// Pipe the child process stdout to the current stdout
Copy link
Collaborator

Choose a reason for hiding this comment

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

This comment should be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed! Good spotting @ehmicky !

@sindresorhus sindresorhus merged commit 2956ea1 into sindresorhus:master Nov 3, 2019
@ehmicky
Copy link
Collaborator

ehmicky commented Nov 3, 2019

Thanks @justsml, this is merged! 馃帀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ehmicky ehmicky ehmicky approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@justsml @sindresorhus @ehmicky