docs: improve readme

danielpza · danielpza · commit de865da89198 · 2019-02-02T18:19:06.000-05:00
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![Built with Spacemacs](https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg)](http://spacemacs.org)
 
-Transforms absolute imports to relative
+Transforms absolute imports to relative from `paths` in your tsconfig.json
 
 ## Install
 
@@ -20,6 +20,10 @@ Add it to _plugins_ in your _tsconfig.json_
 ```json
 {
   "compilerOptions": {
+    "baseUrl": "./",
+    "paths": {
+      "@utils/*": ["utils/*"]
+    },
     "plugins": [{ "transform": "typescript-transform-paths" }]
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)`
`6`	`6`	`[![Built with Spacemacs](https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg)](http://spacemacs.org)`
`7`	`7`
`8`		`-Transforms absolute imports to relative`
	`8`	+Transforms absolute imports to relative from `paths` in your tsconfig.json
`9`	`9`
`10`	`10`	`## Install`
`11`	`11`
`@@ -20,6 +20,10 @@ Add it to _plugins_ in your _tsconfig.json_`
`20`	`20`	```json
`21`	`21`	`{`
`22`	`22`	`"compilerOptions": {`
	`23`	`+ "baseUrl": "./",`
	`24`	`+ "paths": {`
	`25`	`+ "@utils/": ["utils/"]`
	`26`	`+ },`
`23`	`27`	`"plugins": [{ "transform": "typescript-transform-paths" }]`
`24`	`28`	`}`
`25`	`29`	`}`