Add instructions on how to use alias and root options

airbnb · Jul 3, 2017 · 58abcf5 · 58abcf5
1 parent 5b3e8ea
commit 58abcf5
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -66,9 +66,28 @@ npm install --save-dev babel-plugin-inline-react-svg
     ]
   ]
 }
+```
+- *`alias`* - An object with alias for module resolution
+- *`root`* - A relative path string (Starting from CWD), it only works in conjunction with alias.
+Example:
 
+```json
+{
+  "plugins": [
+    [
+        "inline-react-svg", {
+        "root": "./",
+        "alias": {
+          "svgs": "svgs"
+        }
+      }
+    ]
+  ]
+}
 ```
 
+**Note:** If root is not specified it will always start resolving from the project root
+
 ### Via CLI
 
 ```sh