Giter Club home page Giter Club logo

readme-generator's Introduction

README-Generator

GitHub license

Description

A Node application that takes user input to prompts and creates a markdown file in a professional README format. This makes it that much easier to create a README.md for your project in a professional format. It can help someone not familiar with the proper format or just save time. I created this application to practice Node and creating an application without a front end that can be ran in the terminal.

Table of Contents

Installation

Run npm i in the terminal to install all dependencies for the application

Usage

Run node index.js in the terminal and answer all the questions as they appear. After answering all questions, your README.md file will be created. VIDEO DEMO

License

MIT

Contributing

Contact me on Github or by Email Utilized Node and inquirer node package

Tests

npm run test

Questions

If you have any questions about the project, have suggestions, or would like to contribute, please contact me at [email protected]. You can view my other projects on github jdskinne.

readme-generator's People

Contributors

jeremyskinner812 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.