Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 3.17 KB

README.md

File metadata and controls

109 lines (77 loc) · 3.17 KB

:package_name

Latest Version on Packagist Software License Coverage Status Quality Score Total Downloads

Note: Replace :package_name :package_description with their correct values in README.md, CHANGELOG.md, CONTRIBUTING.md, LICENSE.md and composer.json files, then delete this line.

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

Inspired by phpleague/skeleton, peterkokot/php-skeleton and koriym/PHP.Skeleton.

Install

Via Composer, update your composer.json to use martiadrogue/:package_name

"repositories": [
    {
        "type": "git",
        "url": "https://github.com/martiadrogue/:package_name.git"
    }
],

Then you must add martiadrogue/:package_name in require.

"require": {
    "martiadrogue/:package_name": "dev-devel"
},

Or invoke

composer require martiadrogue/:package_name:@dev

Old school, forget all and grab files from this directory

Usage

$skeleton = new MartiAdrogue\Skeleton();
echo $skeleton->echoPhrase('Hello, world!');

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

composer test run phpcs, phpmd and phpunit. Run phpunit for unit test only.

composer test

Code Smell Fix

composer format run php-cs-fixer and phpcbf to fix up the PHP code to follow the coding standards.

composer format

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.