Open hynesy23 opened 3 years ago
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/index.js#L3 Try and keep your internal and external imports separate
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/index.js#L59 Could use ternary operator here instead of if... else
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/index.js#L66 Would be nice to see the user prompted for the title of the README, however, NOT a requirement so no need to worry, just a 'nice to have'
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/index.js#L73 Not the best variable name here, as README file is not generated until you call the writeToFile function. Better name would be generatedMarkdown
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/utils/generateMarkdown.js#L25 No need to add a 'return' after a 'break', as return will exit from the loop/switch anyway
done
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/index.js#L3 Try and keep your internal and external imports separate
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/index.js#L59 Could use ternary operator here instead of if... else
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/index.js#L66 Would be nice to see the user prompted for the title of the README, however, NOT a requirement so no need to worry, just a 'nice to have'
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/index.js#L73 Not the best variable name here, as README file is not generated until you call the writeToFile function. Better name would be generatedMarkdown
https://github.com/Cratesy/readme-generator/blob/a8b5f7c6dbade3e2a1185f518ad42117f8aa2005/utils/generateMarkdown.js#L25 No need to add a 'return' after a 'break', as return will exit from the loop/switch anyway