@redeagle/readme-template

Readme Template

This is a small template README.md file for your projects!

TEMPLATE.md

Table of Contents

• Intro
• Getting started
• Features
• Usefull links
• License
• 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:

#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:

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

$ cd readme-template/

_{⇧ back to top}

Features

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

These tags are used to better navigate the file:

_{⇧ back to top}

Usefull links

For the badges:

• Badge.fury.io
• Shields.io

For markdown:

• StackEdit
• MarkdownGuide

For Github:

• gitmoji
• Github Octodex

For create awesome code pictures for your docs:

• Carbon

Like this:

_{⇧ back to top}

License

This project is licensed under the MIT License - see the LICENSE file for details.

_{⇧ back to top}

Author

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

Email : [e-mail]

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

_{⇧ back to top}