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

Commit 2e9eee0

Browse files
VimSVimS
committed
Update README.md, CHANGELOG.md and LICENSE.md
1 parent e6e35ff commit 2e9eee0

File tree

3 files changed

+44
-17
lines changed

3 files changed

+44
-17
lines changed

‎CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased]
88

9+
## [3.1.0] - 2022-29-04
10+
### Added
11+
- PHP 8.1 compatibility
12+
- glossary_id to translate-method
13+
- ability to run Integration-Tests against custom host if needed (Free/Pro)
14+
### Changed
15+
- migrated phpunit.xml.dist
16+
- fixed some Tests and general Maintenance such as Typos in README.md
17+
### Removed
18+
919
## [3.0.1] - 2021-07-09
1020
### Added
1121
### Changed

‎LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The MIT License (MIT)
22

3-
Copyright (c) 2019 babymarkt.de GmbH <entwicklung@babymarkt.de>
3+
Copyright (c) 2018-2022 babymarkt.de GmbH <entwicklung@babymarkt.de>
44

55
> Permission is hereby granted, free of charge, to any person obtaining a copy
66
> of this software and associated documentation files (the "Software"), to deal

‎README.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
1-
# deepl-php-lib
1+
# deepl-php-lib -
2+
***
3+
## Deprecated Library !
24

5+
Hello everyone,
6+
7+
in the last couple of months we didn't give much attention to this projekt. DeepL on the other hand has developed client libraries for Python, .NET and Node.js (see: [API-Doc][link-deepl-client-libraries]).
8+
9+
Since there is a PHP-Library in the works [Github][link-deepl-php-lib-github] and our track record with maintaining our library hasn't been as good as it should have been, we decided to abandon this library and switch internally to the official one.
10+
11+
To make clear that we won't continue to work on this repository, we will archive it. If anyone from the community wants to continue our work we can put a line in the README to point to the new maintained repository.
12+
13+
Otherwise, we recommend you to check out the new library coming from [DeepL][link-deepl-php-lib-github].
14+
15+
Thank you to everyone who contributed to this project over the years.
16+
17+
***
318
[![Latest Version on Packagist][ico-version]][link-packagist]
419
[![Software License][ico-license]](LICENSE.md)
520
[![Build Status][ico-travis]][link-travis]
@@ -123,21 +138,21 @@ Create a glossary
123138
$glossary = $deepl->createGlossary('MyGlossary', ['Hallo' => 'Hello'], 'de', 'en');
124139
```
125140

126-
| param | Description |
127-
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
128-
| $name | Glossary name
129-
| $entries | Array of entries
130-
| $sourceLanguage | The source language into which the glossary rule apply |
131-
| $targetLanguage | The target language into which the glossary rule apply |
141+
| param | Description |
142+
|-----------------|--------------------------------------------------------|
143+
| $name | Glossary name |
144+
| $entries | Array of entries |
145+
| $sourceLanguage | The source language into which the glossary rule apply |
146+
| $targetLanguage | The target language into which the glossary rule apply |
132147

133148
Delete a glossary
134149
```php
135150
$glossary = $deepl->deleteGlossary($glossaryId);
136151
```
137152

138-
| param | Description |
139-
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
140-
| $glossaryId | Glossary uuid (set by DeepL when glossary is created)
153+
| param | Description |
154+
|-------------|-------------------------------------------------------|
155+
| $glossaryId | Glossary uuid (set by DeepL when glossary is created) |
141156

142157
List glossaries
143158
```php
@@ -157,9 +172,9 @@ $glossaryInformation = $deepl->glossaryInformation($glossaryId);
157172
var_dump($glossaryInformation);
158173
```
159174

160-
| param | Description |
161-
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
162-
| $glossaryId | Glossary uuid (set by DeepL when glossary is created)
175+
| param | Description |
176+
|-------------|-------------------------------------------------------|
177+
| $glossaryId | Glossary uuid (set by DeepL when glossary is created) |
163178

164179
Get glossary entries
165180
```php
@@ -169,9 +184,9 @@ foreach ($entries as $sourceLangText => $targetLangText) {
169184
}
170185
```
171186

172-
| param | Description |
173-
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
174-
| $glossaryId | Glossary uuid (set by DeepL when glossary is created)
187+
| param | Description |
188+
|-------------|-------------------------------------------------------|
189+
| $glossaryId | Glossary uuid (set by DeepL when glossary is created) |
175190

176191
### Configuring cURL requests
177192
If you need to use a proxy, you can configure the underlying curl client to use one. You can also specify a timeout to avoid waiting for several minutes if Deepl is unreachable
@@ -231,3 +246,5 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
231246
[link-author]: https://github.com/Baby-Markt
232247
[link-contributors]: ../../contributors
233248
[link-deepl]: https://www.deepl.com/docs-api/introduction/
249+
[link-deepl-client-libraries]:https://www.deepl.com/en/docs-api/accessing-the-api/client-libraries/
250+
[link-deepl-php-lib-github]:https://github.com/DeepLcom/deepl-php

0 commit comments

Comments
 (0)