Skip to content

doc: add blurb recommending the use of badges - #357

Closed
gabrielschulhof wants to merge 2 commits into
nodejs:docfrom
gabrielschulhof:update-for-badges
Closed

gabrielschulhof wants to merge 2 commits into
nodejs:docfrom
gabrielschulhof:update-for-badges

Conversation

@gabrielschulhof

Copy link
Copy Markdown
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
Comment thread 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
Copy Markdown
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 ?

@NickNaso NickNaso left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@mhdawson mhdawson left a comment

Copy link
Copy Markdown
Member

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
Copy Markdown
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