Giter Site home page Giter Site logo

sadboitay / professional-readme-generator Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 62 KB

A node.js CLI app that gathers prompted information from the user to dynamically generate a professional README, letting developers focus more on their code!

JavaScript 100.00%

professional-readme-generator's Introduction

Professional README Generator

License: Unlicense

Description

A Node.js command line interface app that gathers prompted information from the user to dynamically generate a professional README document, letting developers focus more on their code! This README that you're reading was created in two minutes using this application.

Table of Contents

Installation

Just clone this repo into the desired location on your machine. From the command line within the root directory of the newly cloned repo, run 'npm install inquirer' to install the necessary node modules.

Usage

Once installed, simply run "node index.js" from the command line in the root folder of the app. Follow the prompts to enter the requested information and voila! Once finished, your generated README.md will be created in the /dist folder of the app.

Walkthrough Video

https://watch.screencastify.com/v/bFyZWWRA6dOmfS44LPbP

License

The Unlicense

A license with no conditions whatsoever which dedicates works to the public domain. Unlicensed works, modifications, and larger works may be distributed under different terms and without source code.

View terms and conditions here: The Unlicense

Tests

No tests have been written for this project.

Questions

professional-readme-generator's People

Contributors

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