stephenlprice / read-write-me

A README Generator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README Generator

License NodeJSMarkdown

Overview

Generates a README file from user prompts

Here is a sample recording of the project



Table of Contents

  1. Installation
  2. Usage
  3. Contributing
  4. Code of Conduct
  5. Testing
  6. License
  7. Questions


Installation

To install this project, please do the following:
Clone the repo from Github



Usage

To get started, consider the following:
Use the command line to write text to a .md file



Contributing

Accepted Contributions:

The following contributions are allowed for this project:

  • creating issues
  • suggesting enhancements
  • reporting bugs
  • documentation

Guidelines

To contribute to this project, please abide by the following:
Be productive and give good feedback



Code of Conduct

All contributers must agree and follow the Code of Conduct:
Be nice, respect people



Testing

Testing is more than welcome. Here are a few instructions on how to perform tests:
Run it by writing node index.js in your terminal



License

This project is licensed under the Apache 2.0 license. For more information refer to this link: License



Questions

To communicate with the project owner, use the following contact information:
Created by: stephenlprice
You can ask me any questions at this address: stellopricint@gmail.com

About

A README Generator


Languages

Language:JavaScript 100.0%