diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cee345a..c608fce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,8 +23,19 @@ Truths which we believe to be self-evident: ## Code style -The amphp project adheres to the PSR-2 style guide with the exception that -opening braces for classes and methods must appear on the same line as -the declaration: +The amphp project adheres to the [PSR-2 style guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md +). -https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md +To apply code standards you can run `php-cs-fixer` with following composer command: + +```bash +composer code-style +``` + +## Running the tests + +Run the test suite from root directory: + +```bash +composer test +``` diff --git a/README.md b/README.md index 9106939..4e55d28 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,21 @@ [![Build Status](https://img.shields.io/travis/amphp/template/master.svg?style=flat-square)](https://travis-ci.org/amphp/template) [![CoverageStatus](https://img.shields.io/coveralls/amphp/template/master.svg?style=flat-square)](https://coveralls.io/github/amphp/template?branch=master) -![Unstable](https://img.shields.io/badge/api-unstable-orange.svg?style=flat-square) ![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square) +`amphp/template` provides a template for AMPHP repos. -`amphp/template` is a non-blocking template for use with the [`amp`](https://github.com/amphp/amp) -concurrency framework. - -**Required PHP Version** - -- PHP 5.5+ - -**Installation** +## Installation ```bash -$ composer require amphp/template +composer require amphp/template +``` + +## Example + +```php +