matrix-php-sdk/README.md

49 lines
1.8 KiB
Markdown
Raw Normal View History

2013-08-07 17:33:05 +00:00
# League Skeleton
2014-10-07 09:02:20 +00:00
[![Latest Version](https://img.shields.io/github/release/thephpleague/skeleton.svg?style=flat-square)](https://github.com/thephpleague/skeleton/releases)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Build Status](https://img.shields.io/travis/thephpleague/skeleton/master.svg?style=flat-square)](https://travis-ci.org/thephpleague/skeleton)
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/thephpleague/skeleton.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/skeleton/code-structure)
[![Quality Score](https://img.shields.io/scrutinizer/g/thephpleague/skeleton.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/skeleton)
[![Total Downloads](https://img.shields.io/packagist/dt/league/skeleton.svg?style=flat-square)](https://packagist.org/packages/league/skeleton)
2013-08-07 17:33:05 +00:00
2014-10-14 20:52:07 +00:00
**Note:** Replace `skeleton` with the correct package name in the above URLs, then delete this line.
2013-08-07 17:33:05 +00:00
2014-10-14 20:52:07 +00:00
This is where you 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.
2013-08-07 17:33:05 +00:00
## Install
Via Composer
2014-10-14 20:52:07 +00:00
``` bash
2014-10-21 10:11:07 +00:00
$ composer require league/skeleton
2013-08-07 17:33:05 +00:00
```
## Usage
``` php
$skeleton = new League\Skeleton();
echo $skeleton->echoPhrase('Hello, League!');
```
## Testing
``` bash
$ phpunit
```
## Contributing
2014-02-07 20:43:43 +00:00
Please see [CONTRIBUTING](https://github.com/thephpleague/:package_name/blob/master/CONTRIBUTING.md) for details.
2013-08-07 17:33:05 +00:00
## Credits
- [:author_name](https://github.com/:author_username)
2014-02-07 20:43:43 +00:00
- [All Contributors](https://github.com/thephpleague/:package_name/contributors)
2013-08-07 17:33:05 +00:00
## License
2014-02-07 20:43:43 +00:00
The MIT License (MIT). Please see [License File](https://github.com/thephpleague/:package_name/blob/master/LICENSE) for more information.