leonard-henriquez / readme-boilerplate

🚀 README.md template for your open-source project

Readme Boilerplate

Readme boilerplate and generator

A simple ⚡ readme boilerplate and a generator to customize it even faster!

📚 Table of Contents

• Installation
• Usage
• Support
• Contributing
• License

📦 Installation

First check if you have NPM installed

Before installing this Readme Generator you need to check if you have Node.jsand NPM installed on your computer.

To check if you have Node.js installed, run this command in your terminal:

node -v

If you get an answer like this, it means that Node.js is installed and you may go to the next section.

v10.14.1

To confirm that you have NPM installed you can run this command in your terminal:

npm -v

If you get an answer like this, it means that Node.js is installed and you may go to the next section.

6.4.1

If Node.js or NPM is not installed you can install them on this link

Don't forget to update NPM after installing Node.js:

npm install npm@latest -g

Then install the Readme Generator

npm install --global readme-boilerplate

🚀 Usage

readme-gen

Then, you can modify the content of your readme.

Tips

Here are a few tips to make them more beautiful!

Screencasts with RecordIt

![screencast](http://recordit.co/images/logo.jpg)

Badges with Shield

![badge](https://img.shields.io/badge/LEFT-RIGHT-COLOR.svg)

Emoji cheatsheet

• 🛠️ :hammer_and_wrench:
• 🛰️ :artificial_satellite:
• 🔺 :small_red_triangle:
• 🔻 :small_red_triangle_down:
• ✅ :white_check_mark:
• 🚧 :construction:
• ⚠️ :warning:
• 🚀 :rocket:
• 📚 :books:
• 💼 :briefcase:
• 📦 :package:
• 🔥 :fire:
• ⭐ :star:
• 👍 :+:
• 👎 :-:
• 👉 :point_right:
• 👇 :point_down:
• ⚡ :zap:
• ☁️ :cloud:
• 📩 :envelope_with_arrow:
• 📝 :memo:
• 🦄 :unicorn:

🛠️ Support

Please open an issue for support.

📝 Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

📜 License

GNU GPLv3 © Leonard Henriquez