Your GitHub profile is an extremely important aspect of your public identity as a developer. A well-crafted one allows you to show off your work to other developers as well as potential employers. An important component of your GitHub profile—and one that many new developers often overlook—is the README.md file.
This command line README generator makes it easy to create and fill out a professional README file, quickly and with all the right components!
- Top language and license badges
- Table of Contents for ease of use
Technology | Description | Link |
---|---|---|
Node.js | JavaScript runtime built on Chrome's V8 JavaScript engine | https://nodejs.org/en/ |
Inquirer.js | A collection of common interactive command line user interfaces | https://www.npmjs.com/package/inquirer |
- Download a copy of this repository
- Make sure you have Node.js and npm installed
- Install necessary npm packages via
npm install
- Install necessary npm packages via
- Navigate to the file location of the downloaded repository using the command line
- Run
node index.js
- After completion, a sample-README.md file should appear within the directory
A sample README file can be found in the root directory
Feel free to create a new issue or alternatively, make a pull request!
MIT
Contact me @ simone_cheah@hotmail.com