Skip to content

Commit 814838d

Browse files
author
codeliner
committed
Add info about versions and missing tests in README
1 parent acd56a8 commit 814838d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Generate Immutable Objects with ease!
1010
composer require event-engine/php-data
1111
```
1212

13+
## Versions
14+
- 1.x uses method return type hints to detect ImmutableRecord property types
15+
- Use this version in PHP 7.2 - PHP 7.3 environments
16+
- 2.x makes use of PHP 7.4 property type hints
17+
- Use this version in >= PHP 7.4 environments
18+
1319
## PHPStorm Templates
1420

1521
The `EventEngine\Data` package contains a set of live templates specifically designed to work together with the `EventEngine\Data\ImmutableRecord`.
@@ -22,3 +28,9 @@ Please find the `settings.zip` [here](https://github.com/event-engine/php-data/b
2228
## Usage
2329

2430
Usage is described in the [documentation](https://event-engine.io/api/immutable_state.html)
31+
32+
## No Tests?
33+
34+
Looks strange, right? A stable open source package without a single test can only be a joke ...
35+
You're right! The situation isn't ideal. However, this is a low level package used by [event-engine/php-json-schema](https://github.com/event-engine/php-json-schema).
36+
The tests included there also cover the implementation of this package. Anyway, a pull request that adds some tests is always welcome!

0 commit comments

Comments
 (0)