you-better-readme

Description

Github link https://github.com/itcreativeusa/you-better-readme

Youtube video guide https://youtu.be/-bySQ48sPB8

This you-better-readme was created as a boot camp every week student challenge. It’s a command-line node.js application that accepts user input for generating a readme file with the title of the project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.

Table of Contents

• Installation
• Usage
• Requirements
• Credits
• License

Installation

This application must be installed on the computer. Open your computer’s command prompt (Windows) or terminal (macOS/Linux) and run the application

Requirements

No special requirements

Usage

Run node index.js in the terminal. Follow the prompt questions and enter information about the application repository. The file readme.md will be generated in a root folder.

Simply add text to the text field and press save. After reloading the page, the text will be available.

Sample of the readme file sample_README.md located in a root folder.

Screenshot is located in utils/img folder

Credits

Starter code in files provided by Berkeley Bootcamp for studying purposes.

License

Please refer to the LICENSE in the repo.

This site is open source. Improve this page.