Skip to content

ReadMe-Me is a node CLI that auto-generates ReadMes from a given set of criteria.

Notifications You must be signed in to change notification settings

mcraepv/ReadMe-Me

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReadMe-Me License: MIT

ReadMe-Me is a node application that builds a customizable README.md file for a project through a series of questions.

Table of Contents

Installation

Clone the repository, and make sure you have node and the necessary modules installed before you use it! (Hint: run npm install once you clone the repository.)

Usage

Once you have everything installed, run "node index.js" in your console and answer the questions. App initialization App demo

The ReadMe file will be named README.md, and will be in the cloned repository once its generated. Sample Readme

Demo Video

License

Copyright 2020 Charles McRae Peavy

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Questions

Reach out to me through email or on GitHub!

Github

https://github.com/mcraepv

Email

mcraepv@gmail.com

About

ReadMe-Me is a node CLI that auto-generates ReadMes from a given set of criteria.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages