https://github.com/mleftwich/nodemd

README File Generator
https://github.com/mleftwich/nodemd

Last synced: 7 days ago
JSON representation

README File Generator

• Host: GitHub
• URL: https://github.com/mleftwich/nodemd
• Owner: mleftwich
• Created: 2022-07-14T03:21:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-01T04:30:40.000Z (about 2 years ago)
• Last Synced: 2024-11-06T03:48:25.446Z (about 2 months ago)
• Language: JavaScript
• Size: 158 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

  ![MIT](https://img.shields.io/static/v1?label=License&message=MIT&color=green)

  # Readme Generator

  

  ## Table of Contents

  * [Description](#description)

  * [Technologies](#technologies)

  * [Installation](#installation)

  * [Usage](#usage)

  * [Contributing](#contributing)

  * [Guidelines](#guidelines)

  * [Tests](#tests)

  * [License](#license)

  * [Questions](#questions)

---

  ## Description

  This is a README file generator using node.js, it implements the use of the inquirer and filesystem node packages to generate a professional readme file based on the responses from user input to prompts in a terminal. Includes generation of licensing badge and links to authors github and email.

  This README itself was generated using the app. You can find a demonstration of that process [Here](https://drive.google.com/file/d/141h7A1P8k3hPWwLa86HigRTpJ2MHGptO/view).

  ![screenshot](./imgs/screenshot.png)

  ## Technologies

  * node.js

      * inquirer 

      * filesystem

  ## Installation

   Clone the repository and npm install

  ## Usage

   Run index.js through terminal.

  ## Contributing

   If you'd like to contribute to this project, reach out to me via the email listed below.

  ## Guidelines

   Consider which license is most appropriate for your project and be concise in your descriptions.

  ## Tests

   Tests run in development.

  ## License

   Licensed under [MIT](https://opensource.org/licenses/MIT) 

   ---

  ## Questions

   For any questions you can find me at [GitHub](https://github.com/mleftwich) or email me at [[email protected]](mailto:[email protected])