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

CLI app that takes input and outputs a nicely formatted readme.md file.
https://github.com/ericbwebdev86/readme-generator

inquirer javascript nodejs

Last synced: 3 months ago
JSON representation

CLI app that takes input and outputs a nicely formatted readme.md file.

• Host: GitHub
• URL: https://github.com/ericbwebdev86/readme-generator
• Owner: ericbwebdev86
• Created: 2022-01-25T19:29:09.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-07-13T19:10:42.000Z (over 3 years ago)
• Last Synced: 2025-01-14T14:22:21.102Z (about 1 year ago)
• Topics: inquirer, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# readme-generator  ![Github license](https://img.shields.io/badge/license-MIT-green.svg)

  ## Table of Contents

  1. [Description](#description)

  2. [Tech Used](#Tech-Used)

  3. [Installation](#installation)

  4. [Usage](#usage)

  5. [Credits](#credits)

  6. [Test](#test)

  7. [Contact](#contact)

  8. [License](#license)

  

  ## Description

  This app quickly and easily generates a professional README.md file. This project uses node.JS and inquirer to capture user input via command line, and node's file system module to generate the README.md.

## Tech Used

* javascript

* nodejs

* inquirer

  ## Installation

  Clone the code from https://github.com/ericbwebdev86/readme-generator and run npm install to download the dependencies.

  

  ## Usage

  When creating an application it is important to have a high quality README. This app allows the developer to easily create a README.md and get back to working on the app.

  

  https://user-images.githubusercontent.com/87142377/151221826-0037ff7f-0777-48a8-b19d-a22af498476a.mp4

  ## Credits

  None yet...

  

  ## Test

  N/A

  ## Contact

  Email: ericbwebdev86@gmail.com   

  Github: https://github.com/ericbwebdev86 

  ## License

  MIT license is a short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.