Skip to content

Commit 26e92e4

Browse files
committed
Added readme
1 parent 7adec34 commit 26e92e4

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,44 @@
1-
# test-utilities
1+
# Test utilities
2+
3+
[![Build Status](https://travis-ci.org/php-api-clients/test-utilities.svg?branch=master)](https://travis-ci.org/php-api-clients/foundation)
4+
[![Latest Stable Version](https://poser.pugx.org/api-clients/test-utilities/v/stable.png)](https://packagist.org/packages/api-clients/test-utilities)
5+
[![Total Downloads](https://poser.pugx.org/api-clients/test-utilities/downloads.png)](https://packagist.org/packages/api-clients/test-utilities/stats)
6+
[![Code Coverage](https://scrutinizer-ci.com/g/php-api-clients/test-utilities/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/php-api-clients/test-utilities/?branch=master)
7+
[![License](https://poser.pugx.org/api-clients/test-utilities/license.png)](https://packagist.org/packages/api-clients/foundation)
8+
[![PHP 7 ready](http://php7ready.timesplinter.ch/php-api-clients/test-utilities/badge.svg)](https://appveyor-ci.org/php-api-clients/test-utilities)
9+
10+
# Installation
11+
12+
To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.
13+
14+
```
15+
composer require api-clients/test-utilities
16+
```
17+
18+
# Usage
19+
20+
Any test file can extend `ApiClients\Tools\TestUtilities\TestCase` and it comes with some goodies such as random namespaces and random directories to use for file storage related tests.
21+
22+
# License
23+
24+
The MIT License (MIT)
25+
26+
Copyright (c) 2016 Cees-Jan Kiewiet
27+
28+
Permission is hereby granted, free of charge, to any person obtaining a copy
29+
of this software and associated documentation files (the "Software"), to deal
30+
in the Software without restriction, including without limitation the rights
31+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
32+
copies of the Software, and to permit persons to whom the Software is
33+
furnished to do so, subject to the following conditions:
34+
35+
The above copyright notice and this permission notice shall be included in all
36+
copies or substantial portions of the Software.
37+
38+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
39+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
40+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
41+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
42+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
43+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
44+
SOFTWARE.

0 commit comments

Comments
 (0)