Skip to content

Commit 1e75eb0

Browse files
authored
docs: improve readme (#57)
* Fix typo and lint markdown file * Add information about adding plugin to project using yarn
1 parent 4d4f498 commit 1e75eb0

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,16 @@ Transforms absolute imports to relative from `paths` in your tsconfig.json
1111

1212
## Install
1313

14+
npm:
15+
16+
```sh
17+
npm i -D typescript-transform-paths
18+
```
19+
20+
yarn:
21+
1422
```sh
15-
$ npm i -D typescript-transform-paths
23+
yarn add -D typescript-transform-paths
1624
```
1725

1826
## Usage with [ttypescript](https://github.com/cevek/ttypescript/)
@@ -31,7 +39,7 @@ Add it to _plugins_ in your _tsconfig.json_
3139
}
3240
```
3341

34-
### Transforming declatation paths
42+
### Transforming declaration paths
3543

3644
If you want to generate declaration (_.d.ts_) files with transformed paths you have to
3745
modify your _tsconfig.json_ file:
@@ -114,6 +122,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
114122

115123
<!-- markdownlint-enable -->
116124
<!-- prettier-ignore-end -->
125+
117126
<!-- ALL-CONTRIBUTORS-LIST:END -->
118127

119128
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors)

0 commit comments

Comments
 (0)