Skip to content

Commit 10af1c5

Browse files
committed
Vague README improvements
1 parent fd1985d commit 10af1c5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ echo "console.log('Hello, world!')" | ts-node
4949

5050
You can require `ts-node` and register the loader for future requires by using `require('ts-node').register({ /* options */ })`. You can also use the shortcuts `node -r ts-node/register` or `node -r ts-node/register/type-check` depending on your preferences.
5151

52-
**Note:** If you need to use advanced node.js CLI arguments, use `node -r ts-node/register` instead of the `ts-node` CLI.
52+
**Note:** If you need to use advanced node.js CLI arguments (e.g. `--inspect`), use them with `node -r ts-node/register` instead of the `ts-node` CLI.
5353

5454
### Mocha
5555

@@ -80,9 +80,9 @@ gulp
8080

8181
## Loading `tsconfig.json`
8282

83-
**Typescript Node** uses `tsconfig.json` automatically, use `--skip-project` to skip loading `tsconfig.json`.
83+
**Typescript Node** loads `tsconfig.json` automatically. Use `--skip-project` to the loading `tsconfig.json`.
8484

85-
**NOTE**: You can use `ts-node` together with [tsconfig-paths](https://www.npmjs.com/package/tsconfig-paths) to load modules according to the `paths` section in `tsconfig.json`.
85+
**Tip**: You can use `ts-node` together with [tsconfig-paths](https://www.npmjs.com/package/tsconfig-paths) to load modules according to the `paths` section in `tsconfig.json`.
8686

8787
## Configuration Options
8888

@@ -94,7 +94,7 @@ ts-node --compiler ntypescript --project src/tsconfig.json hello-world.ts
9494

9595
### CLI Options
9696

97-
Support `--print`, `--eval` and `--require` from [node.js CLI options](https://nodejs.org/api/cli.html).
97+
Supports `--print`, `--eval` and `--require` from [node.js CLI options](https://nodejs.org/api/cli.html).
9898

9999
* `--help` Prints help text
100100
* `--version` Prints version information

0 commit comments

Comments
 (0)