uday-rana / codeshift

A command-line tool that translates source code files into a chosen programming language.
MIT License
5 stars 4 forks source link

README.md does not include instruction to run `npm link` #2

Closed vinhyan closed 2 weeks ago

vinhyan commented 2 weeks ago

The README.md file is missing instructions to run npm link, which is necessary for local development and testing of the CLI tool

vinhyan commented 2 weeks ago

I noticed npm install -g . was provided in the instruction, if the user uses this they will not have to run npm link. However, this was indicated as optional which can be confusing to the user if they decide to not use the global -g flag.