dividab / tsconfig-paths

Load node modules according to tsconfig paths, in run-time or via API.
MIT License
1.8k stars 100 forks source link

Update usage documentation #187

Open richwatts0 opened 2 years ago

richwatts0 commented 2 years ago

Your documentation for usage is really not clear enough.

node -r tsconfig-paths/register {path/to/compiled/js.main.js}

jonaskello commented 2 years ago

Do you mean in the README? I think that is exactly what is says there?

richwatts0 commented 2 years ago

It needs to be more eli5 - another example it isn't immediately clear if this works with ES Modules?

jonaskello commented 2 years ago

PRs that improve the documentation is always welcome :-)