项目作者: davidsaulrodriguez

项目描述 :
A nodejs-based cli readme generator.
高级语言: JavaScript
项目地址: git://github.com/davidsaulrodriguez/cli-readme-generator.git
创建时间: 2021-01-07T06:50:10Z
项目社区:https://github.com/davidsaulrodriguez/cli-readme-generator

开源协议:BSD 2-Clause "Simplified" License

下载


CLI ReadMe Generator

The Issues Badge
The Forks Badge
The Stars Badge
The License Badge

Table of Contents

Description

Note: This README file was generated using this application.

This is a simple NodeJS-based command line application that helps you to generate a professional README.md file.

It will contain 4 standard GitHub badges from Sheild.io for: Issues, Forks, Stars, and the project License.

It will generate a README with a TOC (Table of Contents) that has links to the following sections:

  1. Description
  2. Installation
  3. Usage
  4. Contributing
  5. Tests
  6. Questions
  7. License

The License section is dynamic. When you select one of the available licenses it will give you a link to the full license being used that you can read more about on ChooseALicense.com. If you select null for the license type, then the License section will not be included in your generated README.md file.

Demo Gif

Demo gif of Terminal Commands

Demonstration Video

Demo Video of CLI ReadMe Generator

Installation

To install this application you should follow these steps:

  1. git clone https://github.com/davidsaulrodriguez/cli-readme-generator
  2. cd cli-readme-generator
  3. npm install

Usage

To use this application and begin the process of creating your README.md file simply run this command:

  1. npm run start

Contributing

If you’d like to contribute to this project we sure do encourage it!

Be sure to read the CONTRIBUTING.md file first.

Everything you need to know to start contributing to this project will be in that file.

Tests

This program does not have any local test suites, yet!

This will come with a later release :smirk:

Questions

I am open for questions and feedback on this repository, please contact me directly at support@bsdadm.com. For other projects I’ve worked on, see davidsaulrodriguez.

License

This project and all of its source code is released under the BSD-2-Clause license.