From dd003652e3645022d4ed19401d5bf3996411755a Mon Sep 17 00:00:00 2001 From: Tushar Mathur Date: Fri, 4 Nov 2022 13:20:24 +0530 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index da19a85..b43bcf1 100644 --- a/README.md +++ b/README.md @@ -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** + +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"] + ... + }, + } + ```