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

doc: add blurb recommending the use of badges #357

Closed
wants to merge 2 commits into from

Conversation

gabrielschulhof
Copy link
Collaborator

Add blurb to N-API documentation indicating that we recommend the use
of badges.

Fixes: nodejs/node#22796
Re: nodejs/node#22801

This brings @ddlan's doc additions to the README.md in this repo.

Add blurb to N-API documentation indicating that we recommend the use
of badges.

Fixes: nodejs/node#22796
Fixes: nodejs#333
Re: nodejs/node#22801
README.md Outdated

The use of badges is recommended to indicate the minimum version of N-API
required for the module. This helps to determine which Node.js major versions
are supported. The following badges are available:
Copy link
Member

Choose a reason for hiding this comment

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

What do you think to link here the N-API version matrix https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix ?

Copy link
Member

@NickNaso NickNaso left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

gabrielschulhof pushed a commit that referenced this pull request Jan 19, 2019
Add blurb to N-API documentation indicating that we recommend the use
of badges.

PR-URL: #357
Fixes: nodejs/node#22796
Fixes: #333
Re: nodejs/node#22801
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@gabrielschulhof
Copy link
Collaborator Author

Landed in 0679f65.

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.

4 participants