PROJECT

KISS - Keep it simple, stupid!

Quick usage example...

...repeat until it gets clear.

MOTIVATION

Description of the problem that your module solves.

GETTING STARTED

[gt]: #getting-started ‘Getting started guide’

A brief note on environment/machine/tools requisites

INSTALLATION

[i]: #installation ‘Installation guide’

Installation/deployment example

USAGE

[u]: #usage ‘Product usage’

Give more elaborate example here.

API

[a]: #api ‘Module\’s API description’

WARNING!:

Api description should be given here.

Code examples ...

AUTHOR

[auth]: #author ‘Credits & author\’s contacts info ‘
You can follow me on twitter or just email me.

ACKNOWLEDGMENTS

List of people and project that inspired creation of this one:

@PurpleBooth for his readme template posted here
@jxson for his readme example as well.
Github guides for their precious documenting your project article concerning readme creation
CONTRIBUTION & LICENSE
[cpl]:#contribution—license ‘Contribution guide & license info’

Check out (if any) contribution guide or license for more details.

PRODUCTION STATUS & SUPPORT

[ps]: #production-status—support ‘Production use disclaimer & support info’

You should be aware that this project is supported solely by me and provided as is.

If you want to become a patron or offer me a support please [follow here][auth].

Go back to the project description