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

Update README.md by adding missing formattings #2617

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

0xdw
Copy link

@0xdw 0xdw commented Feb 18, 2022

Description of change

Added missing formattings to keep the README.md more clear

@0xdw 0xdw changed the title Update README.md by adding missing formatings Update README.md by adding missing formattings Feb 18, 2022
@rvagg
Copy link
Member

rvagg commented Feb 21, 2022

So .. while this does increase the consistency, I personally dislike that we have node-gyp throughout the readme where it's just referring to the name rather than showing CLI or programmatic usage. I think we've gone back and forth on this question but my vote is to rip them all out.

Not a hard blocker if someone else feels strongly about this.

Thanks for the thoughtful contribution though @0xdw.

@0xdw
Copy link
Author

0xdw commented Feb 21, 2022

@rvagg Agreed! What I thought is that it's better to have a single way of stating the name. Also, I prefer to have the module name highlighted :).

@cclauss
Copy link
Contributor

cclauss commented May 10, 2022

Repetitive highlighting is distracting for the reader.

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

Successfully merging this pull request may close these issues.

3 participants