npm package: @redeagle/readme-template
Description: This is a small template README.md file for your projects!
Author: Alexander Prisyazhnyuk
Latest version: 1.0.3

<p align="center">
  <img src="https://lh3.googleusercontent.com/A0AmC31SEcpE9MtvQTo4DwXGTyGmvVsM5YL_QAk75uc1m0CvwsS7ovgifCFJXjFEJWNAb8DqIJY" alt="Logo">
</p>
<p align="center">
  <a href="https://badge.fury.io/js/%40redeagle%2Freadme-template">
  <img src="https://badge.fury.io/js/%40redeagle%2Freadme-template.svg" alt="npm version">
  </a>
  <a href="https://github.com/redeagleap/readme-template/blob/master/LICENSE">
  <img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="License">
  </a>
</p>
<p align="center">
	<h3 align="center">Readme Template</h3>
	<p align="center">
    This is a small template README.md file for your projects!
  </p>
  <p align="center"><a href="https://github.com/redeagleap/readme-template/blob/master/TEMPLATE.md">TEMPLATE.md</a></p>
</p>

<!-- Used for the "back to top" links within the document -->
<div id="contents"></div>

## Table of Contents

- [Intro](#intro)
- [Getting started](#getting-started)
- [Features](#features)
- [Usefull links](#usefull-links)
- [License](#license)
- [Author](#author)

## Intro

Writing the Readme is an integral part of writing a good program. Until you can put your thought in writing, you still can’t start writing code.

There must be a middle ground between the piles of technical specification papers and its absence, as such. And in fact it is. This golden mean is an inconspicuous and modest Readme file.

Consider the process of writing the Readme file for your project as a true act of creation. This is exactly the place where all your brilliant ideas should be expressed.

## Getting started

### Npm&Yarn install:

```bash
#Nostalgic
$ npm install @redeagle/readme-template

#Hipster
$ yarn add @redeagle/readme-template
```

### Clone the repo:

Clone the repo to get all source files as they are available on Github:

```bash
$ git clone https://github.com/redeagleap/readme-template.git

$ cd readme-template/
```

<sub>[⇧ back to top](#contents)</sub>

## Features

For the header of our `README.md`, we will use HTML markup to centralize the information. Like this:

<p>
  <img  src="https://lh3.googleusercontent.com/WtfsYwwojrMIQKpuMjhxq3-v37eHvmNsojsiPduxk1tcXhOCadXvupiybEZ-B6TxtAFNoRhdk60" alt="header">
</p>

These tags are used to better navigate the file:

<p>
<img src="https://lh3.googleusercontent.com/kgiU13SEJnltN6-yAjiw38SzGAi5foC_MsEe2FcxJJIi9S0r8_kPPD9MOvGolsHhTaDO4CuCEdc" alt="header anchor">
</p>
<p>
<img  src="https://lh3.googleusercontent.com/UBiwKc1TdUFtS8aeDI61nL-sqydwau2RB-V9V9W4a6m4sEAdDzf4Cnsv9M-gewyoukAOxTMz09o" alt="bac to top link">
</p>

<sub>[⇧ back to top](#contents)</sub>

## Usefull links

For the badges:

- [Badge.fury.io](https://badge.fury.io/)
- [Shields.io](https://shields.io/#/)

For markdown:

- [StackEdit](https://stackedit.io/app#)
- [MarkdownGuide](https://www.markdownguide.org/)

For Github:

- [gitmoji](https://gitmoji.carloscuesta.me/)
- [Github Octodex](https://octodex.github.com/)

For create awesome code pictures for your docs:

- [Carbon](https://carbon.now.sh/)

Like this:

<p>
  <img  src="https://lh3.googleusercontent.com/0FN302Wk4ehBmu02YH4M-Q2YxF8gBnucT0k6Q2BBLiYRxWJdJKpUnm_yy3o4coEnVMjCaFE73ew" alt="carbon example">
</p>

<sub>[⇧ back to top](#contents)</sub>

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

<sub>[⇧ back to top](#contents)</sub>

## Author

```txt
Readme Template made with love.
---------------------------------------
Author : Alexander Prisyazhnyuk

Email : insightinyourmind@gmail.com

Github : https://github.com/redeagleap/readme-template.git
```

[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)

<sub>[⇧ back to top](#contents)</sub>