update(README.md)

holgerk · Apr 7, 2024 · 24c889c · 24c889c
1 parent 54e55cc
commit 24c889c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,12 @@
 
 [![run-tests](https://github.com/holgerk/pest-plugin-equal-golden/actions/workflows/tests.yml/badge.svg)](https://github.com/holgerk/pest-plugin-equal-golden/actions/workflows/tests.yml)
 
-Provides a `toEqualGolden` expectation, which behaves identically to the `toEqual` expectation, 
-with the only difference being that if `null` is passed as the expectation, the expectation is 
-automatically created from the current value.
+Provides a `toEqualGolden` assertion, same as `toEqual`, but when `null` is given as argument, the test file is 
+automatically edited and `null` is substituted with the actual value.
 
 So, if you add:
 
-```php 
+```php
 expect(['color' => 'golden'])
     ->toEqualGolden(null);
 ```

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "holgerk/pest-plugin-equal-golden",
-    "description": "Provides a `toEqualGolden` expectation, which behaves identically to the `toEqual` expectation, with the only difference being that if `null` is passed as the expectation, the expectation is automatically created from the current value.",
+    "description": "Provides a toEqualGolden assertion, same as toEqual, but when null is given as argument, the test file is automatically edited and null is substituted with the actual value",
     "keywords": [
         "php",
         "framework",