Skip to content

Commit 059eae2

Browse files
committed
typo in node binding README
1 parent 83c2ca8 commit 059eae2

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

bindings/node/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ This script runs a simple test to ensure the native module was built correctly.
5353
| Name | Description |
5454
|-----:|:------------|
5555
| `__test__` | The location of the unit test(s). |
56-
| `npm` | The required metadata for publishing platform-specific packages to npm. |
56+
| `npm` | The required metadata for publishing platform-specific binary packages to npm. |
5757
| `src` | The location for all rust sources related to binding the cpp-linter library. |
5858
| `build.rs` | The cargo-specific build script used when compiling the binding. |
5959
| `Cargo.toml` | Metadata about the binding's rust package (which _is not_ intended to be published to crates.io). |
60-
| `package.json` | Metadata about the npm package (platform agnostic). |
60+
| `package.json` | Metadata about the npm package (platform agnostic - no binary). |
6161
| `cli.js` | The executable script invoked as a Command Line Interface. |
62-
| `index.d.ts` | The generated TypeScript typing info the describes the exposing functionality in the built native module. |
63-
| `index.js` | The generated script that delegates which platform-specific package to import. |
64-
| `cpp-linter.x-y-z.node` | Then native module built for a specific platform (where `x-y-z` denotes the platform's name using compilation target). |
62+
| `index.d.ts` | The generated TypeScript typing and doc info that describes the exposed API in the built native module. |
63+
| `index.js` | The generated script that delegates which native binary (platform-specific package or dev build) to import. |
64+
| `cpp-linter.x-y-z.node` | The native module built for a specific platform (where `x-y-z` denotes the platform's name using the compilation target). |
6565

6666
Hidden files and folders are not described in the table above.
6767
If they are not ignored by a gitignore specification, then they should be considered

0 commit comments

Comments
 (0)