README

This is the catchphrase: what does this project do and how is it unique?

👁 Build Status
👁 Latest Version
👁 Total Downloads

Here is an additional quick introduction, if necessary.

Why?

Why does this project exist? Come on, don't delete this part. Fill it. Yes it's hard, but it's perhaps the most important part of the README.

As to why this project exist, it's to serve as a template for future open source PHP projects. Of course, feel free to fork it and make your own recipe.

Installation

Describe how to install the project/library/framework/…

Make sure your installation instructions work by testing them!

Example :

Require this package with composer using next command:

$ composer require chiron/roadrunner "^2.4"

Installed composer is required (how to install composer).

You need to fix the major version of package.

After that you

Usage

Describe how to use the project. A gif or a short code example is the best way to show how it works. Also keep paragraphs short and sentences simple: not everybody speaks english well.

For the sake of the example here is how you can use this project template as a basis for your own repository:

git clone https://github.com/ncou/project-template.git my-project
cd my-project
# Remove the git repository metadata
rm -rf .git/
# Start a brand new repository
git init
git add .

Easy peasy! Now you just have to code.