matrix-php-sdk/README.md

52 lines
2.1 KiB
Markdown
Raw Normal View History

2014-12-30 15:31:21 +00:00
# :package_name
2013-08-07 17:33:05 +00:00
2014-12-30 15:31:21 +00:00
[![Latest Version](https://img.shields.io/github/release/thephpleague/:package_name.svg?style=flat-square)](https://github.com/thephpleague/:package_name/releases)
2014-10-07 09:02:20 +00:00
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
2014-12-30 15:31:21 +00:00
[![Build Status](https://img.shields.io/travis/thephpleague/:package_name/master.svg?style=flat-square)](https://travis-ci.org/thephpleague/:package_name)
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/thephpleague/:package_name.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/:package_name/code-structure)
[![Quality Score](https://img.shields.io/scrutinizer/g/thephpleague/:package_name.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/:package_name)
[![Total Downloads](https://img.shields.io/packagist/dt/league/:package_name.svg?style=flat-square)](https://packagist.org/packages/league/:package_name)
2013-08-07 17:33:05 +00:00
2015-02-20 06:45:35 +00:00
**Note:** Replace ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:package_name``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line.
2013-08-07 17:33:05 +00:00
2014-10-27 03:01:45 +00:00
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
2014-10-14 20:52:07 +00:00
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-12-30 15:31:21 +00:00
$ composer require league/:package_name
2013-08-07 17:33:05 +00:00
```
## Usage
``` php
$skeleton = new League\Skeleton();
echo $skeleton->echoPhrase('Hello, League!');
```
## Testing
``` bash
$ phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
2013-08-07 17:33:05 +00:00
2015-02-04 19:40:00 +00:00
## Security
If you discover any security related issues, please email :author_email instead of using the issue tracker.
2013-08-07 17:33:05 +00:00
## Credits
- [:author_name](https://github.com/:author_username)
- [All Contributors](../../contributors)
2013-08-07 17:33:05 +00:00
## License
2014-10-25 20:57:34 +00:00
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.