https://github.com/veronika-pomy/readme-generator

This application helps to generate a professional README file using command line prompt. Built with Node.js.
https://github.com/veronika-pomy/readme-generator

Last synced: 10 days ago
JSON representation

This application helps to generate a professional README file using command line prompt. Built with Node.js.

• Host: GitHub
• URL: https://github.com/veronika-pomy/readme-generator
• Owner: veronika-pomy
• License: mit
• Created: 2023-01-28T22:59:31.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-02T03:39:33.000Z (about 2 years ago)
• Last Synced: 2024-12-01T17:18:37.682Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 103 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Professional README File Generator

[![License][license-shield]][license-url]

## Description

This application generates a professional README file template based on user input. The user inputs needed information when prompted in the command line. 

The generated README file contains the following sections:

- Title of the Project

- Description

- Table of Contents 

- Installation

- Usage

- License 

- Contributing 

- Tests

- Questions

When a user chooses a license from a list of options, that information is added to the license section of the readme, and a badge with the license link is displayed at the top of the readme file. 

The questions section contains information on how to get in touch and the developer's email address and GitHub profile link.

The Table of Contents is functional and links to the appropriate sections of the readme file. 

---

## Table of Contents

  


    


      Description

    

    


      Installation

    

    


      Demo

    

    


        License

    

    


        Questions

    

    


        Acknowledgements

    

  


---

## Installation

Instructions on how ot install the application: the code can be downloaded from the repository on Github and run in Node.js.

---

## Demo

https://user-images.githubusercontent.com/111567114/216225779-ea327b64-0382-48f6-9ab7-8a70654b1be2.mp4

---

## License

Distributed under the MIT License. See "LICENSE.txt" for more information.

---

## Questions

If you have any questions regarding this project, please don't hesitate to contact me using my email address: [email protected]. You can find my project repositories here: [veronika-pomy](https://github.com/veronika-pomy?tab=repositories).

___

## Acknowledgments

This list includes resources used for the project. 

- [Best README Template](https://github.com/othneildrew/Best-README-Template/blob/master/README.md)

- [inquirer](https://www.npmjs.com/package/inquirer)

- [Node.js](https://nodejs.org/en/)

- [Shields.io](https://shields.io/)

- [Vecteezy - free coming soon placeholder image](https://www.vecteezy.com/)

[license-shield]: https://img.shields.io/badge/license-MIT-blue?style=for-the-badge

[license-url]: https://github.com/veronika-pomy/Readme-Generator/blob/main/LICENSE

[product-demo]: https://example.com