Add TypeScript docs

jpkleemans · Jan 20, 2021 · 6d9c62d · 6d9c62d
1 parent 64915c3
commit 6d9c62d
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -22,11 +22,22 @@ npm install vite-svg-loader --save-dev
 ### Setup
 
 #### `vite.config.js`
-
 ```js
 import svgLoader from 'vite-svg-loader'
 
 export default {
   plugins: [vue(), svgLoader()]
 }
 ```
+
+### Use with TypeScript
+If you'd like to use the loader in a TypeScript project, you'll need to add the following type definition to your `tsconfig.json` file:
+
+#### `tsconfig.json`
+```json
+{
+  "compilerOptions": {
+    "types": ["vite-svg-loader", "vite/client"]
+  }
+}
+```