Skip to content

Commit 0174693

Browse files
committed
Update README.md
1 parent 7ce8170 commit 0174693

1 file changed

Lines changed: 52 additions & 7 deletions

File tree

README.md

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,55 @@
11
# image-util-php
2-
[![Build Status](http://img.shields.io/travis/dominionenterprises/image-util-php.svg?style=flat)](https://travis-ci.org/dominionenterprises/image-util-php)
3-
[![Scrutinizer Code Quality](http://img.shields.io/scrutinizer/g/dominionenterprises/image-util-php.svg?style=flat)](https://scrutinizer-ci.com/g/dominionenterprises/image-util-php/)
4-
[![Code Coverage](http://img.shields.io/coveralls/dominionenterprises/image-util-php.svg?style=flat)](https://coveralls.io/r/dominionenterprises/image-util-php)
52

6-
[![Latest Stable Version](http://img.shields.io/packagist/v/dominionenterprises/image-util.svg?style=flat)](https://packagist.org/packages/dominionenterprises/image-util)
7-
[![Total Downloads](http://img.shields.io/packagist/dt/dominionenterprises/image-util.svg?style=flat)](https://packagist.org/packages/dominionenterprises/image-util)
8-
[![License](http://img.shields.io/packagist/l/dominionenterprises/image-util.svg?style=flat)](https://packagist.org/packages/dominionenterprises/image-util)
3+
[![Build Status](https://travis-ci.org/traderinteractive/image-util-php.svg?branch=master)](https://travis-ci.org/traderinteractive/image-util-php)
4+
[![Code Quality](https://scrutinizer-ci.com/g/traderinteractive/image-util-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/traderinteractive/image-util-php/?branch=master)
5+
[![Coverage Status](https://coveralls.io/repos/github/traderinteractive/image-util-php/badge.svg?branch=master)](https://coveralls.io/github/traderinteractive/image-util-php?branch=master)
96

10-
General Image Utility Library
7+
[![Latest Stable Version](https://poser.pugx.org/traderinteractive/image-util/v/stable)](https://packagist.org/packages/traderinteractive/image-util)
8+
[![Latest Unstable Version](https://poser.pugx.org/traderinteractive/image-util/v/unstable)](https://packagist.org/packages/traderinteractive/image-util)
9+
[![License](https://poser.pugx.org/traderinteractive/image-util/license)](https://packagist.org/packages/traderinteractive/image-util)
10+
11+
[![Total Downloads](https://poser.pugx.org/traderinteractive/image-util/downloads)](https://packagist.org/packages/traderinteractive/image-util)
12+
[![Monthly Downloads](https://poser.pugx.org/traderinteractive/image-util/d/monthly)](https://packagist.org/packages/traderinteractive/image-util)
13+
[![Daily Downloads](https://poser.pugx.org/traderinteractive/image-util/d/daily)](https://packagist.org/packages/traderinteractive/image-util)
14+
15+
General Image Utility Library
16+
17+
## Requirements
18+
19+
image-util-php requires PHP 7.0 (or later).
20+
21+
## Composer
22+
To add the library as a local, per-project dependency use [Composer](http://getcomposer.org)! Simply add a dependency on
23+
`traderinteractive/image-util` to your project's `composer.json` file such as:
24+
25+
```sh
26+
composer require traderinteractive/image-util
27+
```
28+
29+
## Documentation
30+
31+
Found in the [source](src) itself, take a look!
32+
33+
## Contact
34+
35+
Developers may be contacted at:
36+
37+
* [Pull Requests](https://github.com/traderinteractive/image-util-php/pulls)
38+
* [Issues](https://github.com/traderinteractive/image-util-php/issues)
39+
40+
## Project Build
41+
42+
With a checkout of the code get [Composer](http://getcomposer.org) in your PATH and run:
43+
44+
```sh
45+
./vendor/bin/phpunit
46+
./vendor/bin/phpcs
47+
```
48+
49+
There is also a [docker](http://www.docker.com/)-based [fig](http://www.fig.sh/) configuration that will execute the build inside a docker container. This is an easy way to build the application:
50+
51+
```sh
52+
fig run build
53+
```
54+
55+
For more information on our build process, read through out our [Contribution Guidelines](.github/CONTRIBUTING.md).

0 commit comments

Comments
 (0)