File: README_EN.md

Recommend this page to a friend!

README_EN.md

File:	`README_EN.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	PHP Skeleton Generate code and files for PHP project skeletons
Author:	By Josantonius
Last change:
Date:	6 years ago
Size:	`5,001 bytes`

PHP Package library

Description.

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

The preferred way to install this extension is through Composer.

To install PHP __Package__ library, simply:

$ composer require __Vendor__/__Package__

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require __Vendor__/__Package__ --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/__Vendor__/__PREFIX____Package__.git

Or install it manually:

$ wget https://raw.githubusercontent.com/__Vendor__/__PREFIX____Package__/master/src/__Package__.php

Available methods in this library:

__Package__::sample($attr);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $attr | Description. | [DATATYPE] | [Yes/No] | [] |

# Return (string) ? Description.

To use this library with Composer:

require __DIR__ . '/vendor/autoload.php';

use __Vendor__\__Package__\__Package__;

Or If you installed it manually, use it:

require_once __DIR__ . '/__Package__.php';

use __Vendor__\__Package__\__Package__;

Example of use for this library:

To run tests you just need composer and to execute the following:

$ git clone https://github.com/__Vendor__/__PREFIX____Package__.git

$ cd __PREFIX____Package__

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

$ composer phpmd

Run all previous tests:

$ composer tests

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

Fork and clone.
Run the command `composer install` to install the dependencies. This will also install the dev dependencies.
Run the command `composer fix` to excute code standard fixers.
Run the tests.
Create a branch, commit, push and send me a pull request.