Skip to content

Readme generator that runs in the command line terminal to create a readme file for your project using npm.

License

Notifications You must be signed in to change notification settings

Chriscds/npm-readme-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NPM Readme Generator

License: MIT

Description

A node.js application, to generate a readme file for your project from the command line using npm. Create a README.md file from user input, including license badges and contact information, to save time on writing out the users initial README.md.

You can view a video of the working application here

Table of Contents

Installation

Install the necessary dependencies, use the following command line:

  npm install

Usage

Use this application by running the below command line:

  node index.js

Screenshots

Command Line Screenshot

Generated README

License

This project is licensed under MIT.

Contributing

Contribute to the project using the following:

  1. Fork this project.
  2. Create a feature branch:
  git checkout -b feature/Your_Branch_Name
  1. Commit changes:
  git commit -m "Your changes"
  1. Push to the Main branch:
  git push origin feature/Your_Branch_Name
  1. Open a pull request.

Tests

Questions

Any questions relating to this repository can be opened in an issue, or feel free to contact me directly at csouthon44@gmail.com.

Please take a look at the rest of my work at: Chriscds

About

Readme generator that runs in the command line terminal to create a readme file for your project using npm.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published