Skip to content

doc: Add blurb to N-API recommending the use of badges #22801

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ddlan wants to merge 7 commits into from
Closed

doc: Add blurb to N-API recommending the use of badges #22801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
970dc01
doc: Add blurb recommending the use of badges
ddlan Sep 11, 2018
4bf44d4
doc: added descriptive alt text to N-API blurb for badge use
ddlan Sep 11, 2018
7df5f0a
doc: spacing and char limit on N-API blurb for badge use
ddlan Sep 12, 2018
26af3f1
doc: assets for N-API version badge recommendation
ddlan Sep 17, 2018
1037a33
doc: renamed assets for N-API badge recommendation
ddlan Sep 17, 2018
caca91f
doc: update N-API badge images to be hosted in repo
ddlan Sep 17, 2018
0c243e2
doc: update N-API badge image to use absolute path
ddlan Sep 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,17 @@ opt-in to access those APIs:
In this case the entire API surface, including any experimental APIs, will be
available to the module code.

### Badges
Comment thread
ddlan marked this conversation as resolved.

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:

![N-API v1 Badge](/doc/api_assets/N-API%20v1%20Badge.svg)
![N-API v2 Badge](/doc/api_assets/N-API%20v2%20Badge.svg)
![N-API v3 Badge](/doc/api_assets/N-API%20v3%20Badge.svg)
![N-API Experimental Version Badge](/doc/api_assets/N-API%20Experimental%20Version%20Badge.svg)

Comment thread
ddlan marked this conversation as resolved.
## N-API Version Matrix

| | 1 | 2 | 3 |
Expand Down
1 change: 1 addition & 0 deletions doc/api_assets/N-API Experimental Version Badge.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/api_assets/N-API v1 Badge.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/api_assets/N-API v2 Badge.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/api_assets/N-API v3 Badge.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.