jbtiglao / readme-generator

A command-line application that dynamically generates a professional README.md file from a user's input using the Inquirer package.

09 Node.js Homework: Professional README Generator

---

Description

A command-line application that dynamically generates a professional README.md file from a user's input using the Inquirer package.

Video

Below is the link to the walk-through video demonstrating the application's functionalities:

Watch or download the demonstration video here.

(Note: While testing the video and Screencastify app, the author has found that the video is clearer when downloaded and viewed locally, than when played directly on Screencastify.)

Pre-Installation Guidelines

1. Before installing any npm dependencies, a .gitignore file was created. The file includes node_modules/ and .DS_Store/ so that the node_modules directory isn't tracked or uploaded to GitHub.

2. The repository for this project includes a package.json with the required dependencies. This was created by running npm init when the author first set up the project, before installing any dependencies.

---

Table of Contents

1. Title
2. Description
3. Installation
4. Usage
5. License
6. Contributing
7. Tests
8. Credits
9. Author
10. Questions

---

Installation

Clone my repository on GitHub:

https://github.com/jbtiglao/readme-generator

---

Usage

Please see the walk-through video above, as well as the following instructions and screenshots.

Features

1. The application is initialized by opening the integrated terminal on Visual Studio Code and entering

node index.js

readme-generator

2. Prompts about the project title, description, installation guidelines, usage instructions, usage information, and tests appear on the terminal. The information the user enters as a response to these prompts are added to the corresponding sections on the README. They are the following:

• Project Title.
• Description, Installation, Usage, Contributing, and Tests.
• License, which when selected from the list, returns a license badge placed on top of the README file, near the project title. The badge links to a webpage containing information about the license and takes the user to the said webpage when clicked. Aside from the license badge on top, a notice about the license used by the application is also included on the License section.
• Questions section, which includes instructions on how to reach the author for additional questions or reporting issues, as well as the author's email, GitHub name, and a link to his/her GitHub profile.

prompts

3. A Table of Contents containing sections of the README file. When a section is clicked, the user is taken to the particular section containing the information about the application.

4. Here is a side-by-side comparison of the raw generated README file and as previewed on VS Code:

table-of-contents

installation

questions

---

License

License used for this project - MIT

For more information on the above license and other license types, please see the following websites:

• Open Source Initiative
• Choose a License

---

Contributing

To contribute to this application:

• Submit a pull request.
• Your new features will be merged after review and approval.

---

Tests

The functionalities of this project were tested manually, by opening the application on the integrated terminal and entering

node index.js

then responding to the series of prompts until a README file is generated.

Below is a sample of a README file from such test:

Test 1

---

Credits

The following people/resources were consulted and/or utilized in the development of this application:

• Unit 9, Node.js reading materials and internet resources, UCI Bootcamp.
• Inquirer package.
• Professional README Guide
• Open Source Initiative
• Choose a License
• Apache

---

Author

Jane Tiglao

---

Questions

For questions or issues, please contact:

• Jane Tiglao
• Email: [email protected]
• GitHub Username: jbtiglao
• GitHub Profile: https://github.com/jbtiglao