Add details about how to use #39
Conversation
|
This will simply not work if some random package in node_modules uses |
|
|
||
| **Steps** | ||
|
|
||
| 1. Add library as a dependency. | ||
| ```bash | ||
| npm i chrome-types --save-dev | ||
| ``` | ||
| 3. Update compiler options in `tsconfig.json` | ||
|
|
||
| ```patch | ||
| { | ||
| "compilerOptions": { | ||
| ... | ||
| + "types": ["chrome-types"] | ||
| ... | ||
| }, | ||
| } | ||
| ``` |
There was a problem hiding this comment.
There was a problem hiding this comment.
I think it would be nice to include either the default node_modules directly, or a note that you need to do that. Would you be ok adding that @tusharmath?
There was a problem hiding this comment.
I think it would be nice to include either the default node_modules directly, or a note that you need to do that. Would you be ok adding that @tusharmath?
I agree that a note is appropriate.
| ```bash | ||
| npm i chrome-types --save-dev | ||
| ``` | ||
| 3. Update compiler options in `tsconfig.json` |
There was a problem hiding this comment.
Nit: This should be two 2 (or 1 if you want to rely on Markdown handling the increment)
| @@ -30,3 +30,21 @@ See [the wiki](https://github.com/GoogleChrome/chrome-types/wiki) for more. | |||
| Running the code requires Node 16+ as well as a working version of Python (3 is preferred, but 2.7+ should work) installed on your system. | |||
| This has only been tested on Linux and macOS. | |||
| Python is used to convert Chromium's internal IDL format to JSON. | |||
|
|
|||
| **Steps** | |||
There was a problem hiding this comment.
Could we put this under a new ### As a dependency header? Steps seems a bit weird since the rest of the text above is talking about how to build.
|
|
||
| 1. Add library as a dependency. | ||
| ```bash | ||
| npm i chrome-types --save-dev |
There was a problem hiding this comment.
| npm i chrome-types --save-dev | |
| npm install --save-dev chrome-types |
It's useful to use/suggest canonical command forms in documentation
No description provided.