├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE.md ├── README.md ├── composer.json └── src └── SkeletonClass.php /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | #Changelog 2 | All Notable changes to `:package_name` will be documented in this file 3 | 4 | ## NEXT - YYYY-MM-DD 5 | 6 | ### Added 7 | - Nothing 8 | 9 | ### Deprecated 10 | - Nothing 11 | 12 | ### Fixed 13 | - Nothing 14 | 15 | ### Remove 16 | - Nothing 17 | 18 | ### Security 19 | - Nothing -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Contributions are **welcome** and will be fully **credited**. 4 | 5 | We accept contributions via Pull Requests on [Github](https://github.com/thephpleague/:package_name). 6 | 7 | 8 | ## Pull Requests 9 | 10 | - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). 11 | 12 | - **Add tests!** - Your patch won't be accepted if it doesn't have tests. 13 | 14 | - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. 15 | 16 | - **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. 17 | 18 | - **Create feature branches** - Don't ask us to pull from your master branch. 19 | 20 | - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. 21 | 22 | - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting. 23 | 24 | 25 | ## Running Tests 26 | 27 | ``` bash 28 | $ phpunit 29 | ``` 30 | 31 | 32 | **Happy coding**! 33 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | # The MIT License (MIT) 2 | 3 | Copyright (c) 2013 :author_name <:author_email> 4 | 5 | > Permission is hereby granted, free of charge, to any person obtaining a copy 6 | > of this software and associated documentation files (the "Software"), to deal 7 | > in the Software without restriction, including without limitation the rights 8 | > to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | > copies of the Software, and to permit persons to whom the Software is 10 | > furnished to do so, subject to the following conditions: 11 | > 12 | > The above copyright notice and this permission notice shall be included in 13 | > all copies or substantial portions of the Software. 14 | > 15 | > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | > THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # League Skeleton 2 | 3 | [![Latest Version](https://img.shields.io/github/release/thephpleague/skeleton.svg?style=flat-square)](https://github.com/thephpleague/skeleton/releases) 4 | [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md) 5 | [![Build Status](https://img.shields.io/travis/thephpleague/skeleton/master.svg?style=flat-square)](https://travis-ci.org/thephpleague/skeleton) 6 | [![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/thephpleague/skeleton.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/skeleton/code-structure) 7 | [![Quality Score](https://img.shields.io/scrutinizer/g/thephpleague/skeleton.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/skeleton) 8 | [![Total Downloads](https://img.shields.io/packagist/dt/league/skeleton.svg?style=flat-square)](https://packagist.org/packages/league/skeleton) 9 | 10 | **Note:** Replace `skeleton` with the correct package name in the above URLs, then delete this line. 11 | 12 | This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what 13 | PSRs you support to avoid any confusion with users and contributors. 14 | 15 | ## Install 16 | 17 | Via Composer 18 | 19 | ``` bash 20 | $ composer require league/skeleton 21 | ``` 22 | 23 | ## Usage 24 | 25 | ``` php 26 | $skeleton = new League\Skeleton(); 27 | echo $skeleton->echoPhrase('Hello, League!'); 28 | ``` 29 | 30 | ## Testing 31 | 32 | ``` bash 33 | $ phpunit 34 | ``` 35 | 36 | ## Contributing 37 | 38 | Please see [CONTRIBUTING](https://github.com/thephpleague/:package_name/blob/master/CONTRIBUTING.md) for details. 39 | 40 | ## Credits 41 | 42 | - [:author_name](https://github.com/:author_username) 43 | - [All Contributors](https://github.com/thephpleague/:package_name/contributors) 44 | 45 | ## License 46 | 47 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information. 48 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "league/:package_name", 3 | "description": ":package_description", 4 | "keywords": [ 5 | "league", 6 | "package" 7 | ], 8 | "homepage": "https://github.com/php-loep/:package_name", 9 | "license": "MIT", 10 | "authors": [ 11 | { 12 | "name": ":author_name", 13 | "email": "author_email@example.com", 14 | "homepage": "http://author-website.example.com", 15 | "role": "Developer" 16 | } 17 | ], 18 | "require": { 19 | "php" : ">=5.3.0" 20 | }, 21 | "require-dev": { 22 | "phpunit/phpunit" : "4.*" 23 | }, 24 | "autoload": { 25 | "psr-4": { 26 | "League\\Skeleton\\": "src" 27 | } 28 | }, 29 | "autoload-dev": { 30 | "psr-4": { 31 | "League\\Skeleton\\Test\\": "tests" 32 | } 33 | }, 34 | "extra": { 35 | "branch-alias": { 36 | "dev-master": "1.0-dev" 37 | } 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/SkeletonClass.php: -------------------------------------------------------------------------------- 1 |