mirror of
https://github.com/danog/template.git
synced 2024-11-29 20:19:00 +01:00
readme
This commit is contained in:
parent
c04f14628a
commit
45447a3468
@ -23,8 +23,19 @@ Truths which we believe to be self-evident:
|
|||||||
|
|
||||||
## Code style
|
## Code style
|
||||||
|
|
||||||
The amphp project adheres to the PSR-2 style guide with the exception that
|
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
|
||||||
opening braces for classes and methods must appear on the same line as
|
).
|
||||||
the declaration:
|
|
||||||
|
|
||||||
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
|
||||||
|
```
|
||||||
|
22
README.md
22
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)
|
[![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)
|
[![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)
|
![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)
|
## Installation
|
||||||
concurrency framework.
|
|
||||||
|
|
||||||
**Required PHP Version**
|
|
||||||
|
|
||||||
- PHP 5.5+
|
|
||||||
|
|
||||||
**Installation**
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ composer require amphp/template
|
composer require amphp/template
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```php
|
||||||
|
<?php
|
||||||
|
|
||||||
|
require 'vendor/autoload.php';
|
||||||
|
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user