When initiating an open-source project on GitHub, crafting a well-crafted README is crucial. It should encompass the application's objectives, instructions on utilizing the app, guidance on installation, reporting issues, and providing insights on how others can contribute. This final aspect significantly enhances the chances of attracting contributions from fellow developers and ensuring the project's success. This is a command-line application that dynamically generates a professional README.md file from user input using the Inquirer package.
To install the necessary dependencies, run the following command: npm install node npm install inquirer^8.0.0: The inquirer will prompt you for your inputs from the command line.
The application will start by running node index.js in the command line. Answer the prompts in your command line to generate the README. After answering all the prompts, your README file will be named 'example_README.md' and will be ready for you at the root of the repo. Because this is a command-line application won’t be deployed, here is a Link to a video walkthrough that demonstrates the functionality of my application.
This project is licensed under the terms of the MIT License.
Please feel free to reach out to me with any questions. Github: https://github.com/prarthana1998 Email Address: 12.prarthanakandwal@gmail.com