https://github.com/luctst/get-readme

CLI tool to generate an esthetic README file 🔖🔖
https://github.com/luctst/get-readme

cli cli-app cli-tool generate-readme nodejs nodejs-modules nodejs-tools

Last synced: about 1 month ago
JSON representation

CLI tool to generate an esthetic README file 🔖🔖

• Host: GitHub
• URL: https://github.com/luctst/get-readme
• Owner: luctst
• Created: 2019-07-24T16:37:10.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-08-31T10:12:53.000Z (over 4 years ago)
• Last Synced: 2024-11-13T19:40:23.922Z (5 months ago)
• Topics: cli, cli-app, cli-tool, generate-readme, nodejs, nodejs-modules, nodejs-tools
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/get-good-readme
• Size: 54.7 KB
• Stars: 14
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-readme-tools - Get Readme - CLI tool to generate an esthetic readme file 🔖. (Readme Generator)

README

        


  

  	

  

  


  


  


    get-readme

  

  


     Quickly generate readable and well documented README file. Because documenting is a complicated task get-good-readme is a tiny CLI module which allows you to choose between different README templates for you to keep a coherence between your different projects.

  

  


[![Build Status](https://travis-ci.com/luctst/get-readme.svg?branch=master)](https://travis-ci.com/luctst/get-readme)

[![NPM version](https://img.shields.io/npm/v/get-readme?style=flat-square)](https://img.shields.io/npm/v/get-readme?style=flat-square)

[![Package size](https://img.shields.io/bundlephobia/min/get-readme)](https://img.shields.io/bundlephobia/min/get-readme)

[![Dependencies](https://img.shields.io/david/luctst/get-readme.svg?style=popout-square)](https://david-dm.org/luctst/get-readme)

[![devDependencies Status](https://david-dm.org/luctst/get-readme/dev-status.svg?style=flat-square)](https://david-dm.org/luctst/get-readme?type=dev)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![Twitter](https://img.shields.io/twitter/follow/luctstt.svg?label=Follow&style=social)](https://twitter.com/luctstt)

  



---

**Content**

* [Features](##features)

* [Install](##install)

* [Usage](##usage)

* [Examples](##examples)

* [Contributing](##contributing)

* [Maintainers](##maintainers)

## Features ✨

* Fast.

* Lightweight.

* Quickly generate your README file.

* Good for all kind of projects.

## Install 🐙

> **Note** - If you had `[email protected]` or more you can skip this section.

You can install get-good-readme by entering this command

```

npm install -g get-good-readme

```

## Usage 💡

1. Create a new folder.

2. Open your terminal and go inside the new folder.

3. If you had npx:

	* if you had npx run `npx get-good-readme` and follow the instructions.

4. If you don't have npx:

	* Check the install section to install the package globally.

	* Then execute the tasks number 1 and 2.

	* Run `get-good-readme` in your terminal.

## Examples 🖍

```

npx get-good-readme -p=project-name -g=github-user -d="describe why you're creating this project."

```

## Contributing 🍰

Please make sure to read the [Contributing Guide](https://github.com/luctst/get-readme/blob/master/.github/CONTRIBUTING.md) before making a pull request.

Thank you to all the people who already contributed to this project!

## Maintainers 👷

List of maintainers, replace all `href`, `src` attributes by your maintainers datas.

  

    
Tostee Lucas
💻

  

## License ⚖️

MIT

---



	

		File generated with get-good-readme module