Repository Boilerplate

Description of the repository

Requirements

Optional

If user needs something to install before he can use this project

• npm
• yarn
• composer
• brew
• root permissions

Installation

Commands

# if npm package
$ npm install <package>
# or
$ yarn add <package>

# if composer package
$ composer require <package>

# if linux runnable
$ sudo make install

# if osX brew package
$ brew install <package>

# etc

Usage

Examples how to use this project - code samples, commands, ...

Documentation

Links or references to other docs or external content

Contributing

Informations for users that want to contribute to this project

License

MIT license