Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit bd4ffd7

Browse files
update readme
1 parent b30bbd4 commit bd4ffd7

File tree

3 files changed

+51
-42
lines changed

3 files changed

+51
-42
lines changed

LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) 2019 babymarkt.de GmbH <[email protected]>
4+
5+
> Permission is hereby granted, free of charge, to any person obtaining a copy
6+
> of this software and associated documentation files (the "Software"), to deal
7+
> in the Software without restriction, including without limitation the rights
8+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
> copies of the Software, and to permit persons to whom the Software is
10+
> furnished to do so, subject to the following conditions:
11+
>
12+
> The above copyright notice and this permission notice shall be included in
13+
> all copies or substantial portions of the Software.
14+
>
15+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
> THE SOFTWARE.

README.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# deepl-php-lib
22

3-
[![Build Status](https://travis-ci.org/Baby-Markt/deepl-php-lib.svg?branch=master)](https://travis-ci.org/Baby-Markt/deepl-php-lib)
4-
[![Latest Stable Version](https://poser.pugx.org/babymarkt/deepl-php-lib/v/stable.svg)](https://packagist.org/packages/babymarkt/deepl-php-lib)
5-
[![Total Downloads](https://poser.pugx.org/babymarkt/deepl-php-lib/downloads.png)](https://packagist.org/packages/babymarkt/deepl-php-lib)
3+
[![Latest Version on Packagist][ico-version]][link-packagist]
4+
[![Software License][ico-license]](LICENSE.md)
5+
[![Build Status][ico-travis]][link-travis]
6+
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
7+
[![Quality Score][ico-code-quality]][link-code-quality]
8+
[![Total Downloads][ico-downloads]][link-downloads]
69

710
Simple PHP Library for DeepL API. You can translate one or multiple text strings (up to 50) per request.
811

9-
## Installation
12+
## Install
1013

1114
Use composer if you want to use this library in your project.
1215

@@ -46,34 +49,40 @@ foreach ($translations as $translation) {
4649
}
4750
```
4851

49-
## Run PHPUnit Tests
52+
## Testing
5053

51-
Clone the repository.
54+
Run PHPUnit Tests.
5255

5356
```bash
54-
git clone [email protected]:Baby-Markt/deepl-php-lib.git
57+
composer test
5558
```
5659

57-
Create phpunit.xml from dist file.
60+
Run Check-Style.
5861

5962
```bash
60-
cp phpunit.xml.dist phpunit.xml
63+
composer cs
6164
```
6265

63-
Install composer dependencies.
66+
## Credits
6467

65-
```bash
66-
composer install
67-
```
68+
- [arkadiusjonczek][link-author]
69+
- [All Contributors][link-contributors]
6870

69-
Now, run PHPUnit Tests.
71+
## License
7072

71-
```bash
72-
vendor/bin/phpunit
73-
```
73+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
7474

75-
Or use composer.
75+
[ico-version]: https://img.shields.io/packagist/v/babymarkt/deepl-php-lib.svg?style=flat-square
76+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
77+
[ico-travis]: https://img.shields.io/travis/Baby-Markt/deepl-php-lib/master.svg?style=flat-square
78+
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/babymarkt/deepl-php-lib.svg?style=flat-square
79+
[ico-code-quality]: https://img.shields.io/scrutinizer/g/babymarkt/deepl-php-lib.svg?style=flat-square
80+
[ico-downloads]: https://img.shields.io/packagist/dt/babymarkt/deepl-php-lib.svg?style=flat-square
7681

77-
```bash
78-
composer test
79-
```
82+
[link-packagist]: https://packagist.org/packages/babymarkt/deepl-php-lib
83+
[link-travis]: https://travis-ci.org/Baby-Markt/deepl-php-lib
84+
[link-scrutinizer]: https://scrutinizer-ci.com/g/babymarkt/deepl-php-lib/code-structure
85+
[link-code-quality]: https://scrutinizer-ci.com/g/babymarkt/deepl-php-lib
86+
[link-downloads]: https://packagist.org/packages/babymarkt/deepl-php-lib
87+
[link-author]: https://github.com/arkadiusjonczek
88+
[link-contributors]: ../../contributors

0 commit comments

Comments
 (0)