leightongrant / readme-generator

A node.js app to generate a professional README.

Readme Generator

An app to generate a README

Description

This app will generate a professional looking README for your next project. Just run the app, follow the prompts with the required information and check your folder for your newly generated file.

(back to top)

Table of Contents

• Installation
• Usage
• Contributing
• Tests
• Questions
• License

(back to top)

Installation

To install this app follow the steps below

• git clone [repo] - To clone repository
• npm install - To download dependencies

(back to top)

Usage

Follow the steps below to use the app

• Type: node index.js filename.md
• Follow the prompts
• Enter required information
• Check folder for newly generated README.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

• Fork the project
• Create your feature branch
• Commit your changes
• Push to branch
• Open a pull request

(back to top)

Tests

To do tests, run the following command/s

• npm test

(back to top)

Questions

If you have any questions about the repo, open an issue or contact me directly.

Contact me directly at: [e-mail]

Find more info about my work at: misterouija

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Screenshot