Merge pull request #65 from karlhorky/patch-1

Add postinstall script to readme
jeffijoe · Jan 29, 2021 · a623e61 · a623e61
2 parents c1f4630 + e649fa5
commit a623e61
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -65,6 +65,28 @@ Alternatively, you can use a TypeSync config file: `.typesyncrc` or a `"typesync
 }
 ```
 
+## Run TypeSync Automatically After Every Install
+
+To run TypeSync and install packages automatically after every package install, use a `postinstall` script to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "postinstall": "typesync && npm install"
+  }
+}
+```
+
+Or, if you use `yarn`:
+
+```json
+{
+  "scripts": {
+    "postinstall": "typesync && yarn"
+  }
+}
+```
+
 # Typings packages
 
 TypeSync will add typings for packages that: