Giter Club home page Giter Club logo

pro-readme-generator's Introduction

Professional README Generator

Description

My motivation is to generate a high-quality README file through the command-line, which would enable project creators to devote more time to work on their project. READMEs are essential for other developers and users to know what the app is for, how to install it, how to report issues, and how they can make contributions to imrpve the project.

Table of Contents

Installation

As the developer, I downloaded and used Node.js's Inquirer package to access user prompts to generate their project's README file. No extra installations are needed for the user, aside from a working computer and internet.

Usage

Please check out the link for a video tutorial of how to use my application: https://drive.google.com/file/d/1PHqMsW3gGwH_mcPguQWssZiby2fsj-Gm/view.

Credits

No collaborators were used for the project

License

This application used Node.js, which is licensed under MIT.

How to Contribute

Thank you for your interest! Please contact me via email should you have suggestions or feedback to improve my app.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.