Giter Club home page Giter Club logo

readme-generator's Introduction

README Generator

Table of Contents ๐Ÿ‘€



Description

๐Ÿ—’ A node.js application that allows you to just answer the prompts and receive a README.md that is ready to go! See a sample in the sample folder or here

Installation

โœ… First, you will need to clone this repository to your computer. Once in the root directory, run npm install. Follow this link to watch a step by step video for installation.

Usage

๐Ÿ’ป To use this application, run node index.js in the terminal at the root of the project directory. You will then answers the prompts shown so a new README.md file can be created in the dist folder. Follow this link to see how to video.

Contribution

๐Ÿ‘ฅ Contributions are welcome! Please check out this link for detailed instructions on contributing here by MarcDiethelm. Once you have contributed, your name will be added below in the contributors section!

Contributors

๐Ÿ’— Audry Ford

Connect

๐Ÿ“ง Questions or comments? Please reach out or create an issue!
GitHub: github.com/audryf
Email: [email protected]

readme-generator's People

Contributors

audryf avatar

Watchers

 avatar

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.