Giter Site home page Giter Site logo

kayleriegerpatton / readme-generator Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 824 KB

Command line README file generator using Node.js and the inquirer package. App takes in user input and generates readme sections including description, table of contents, and optional scripts, video, screenshot, and deployed url sections.

License: MIT License

JavaScript 100.00%

readme-generator's Introduction

README Generator MIT

Table of Contents

Description

Command line professional README generator using Node.js and the inquirer package. The app takes in user input; generates readme sections including project information, table of contents, and optional script sections; and outputs a formatted markdown file.

Technologies

  • Node.js
  • inquirer package

Getting Started

Installation

Run the following script to test the application:

$ git clone https://github.com/kayleriegerpatton/readme-generator.git
$ cd readme-generator
$ npm install

Usage

Run the following script to use the application:

$ npm run start

Contributing

To contribute to this project, please email me.

License

MIT License

Demo Video

Click to view the app demo video

command line runthrough of coded question prompts and resulting markdown file

readme-generator's People

Contributors

kayleriegerpatton avatar

Watchers

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