Cleanup readme and composer description

8ctopus · Aug 31, 2023 · 080bcf3 · 080bcf3
1 parent f51e324
commit 080bcf3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 ![code coverage badge](https://raw.githubusercontent.com/8ctopus/relaxed-json/image-data/coverage.svg)
 ![lines of code](https://raw.githubusercontent.com/8ctopus/relaxed-json/image-data/lines.svg)
 
-Tired of json's strict syntax? Then relaxed json if for you.
+Tired of JSON's super strict syntax? Then relaxed JSON if for you.
 
 ## features
 
@@ -24,15 +24,15 @@ Tired of json's strict syntax? Then relaxed json if for you.
 ## usage
 
 ```php
-$text = <<<JSON
+$json = <<<JSON
 {
     // maximum requests per hour
     "throttleThreshold": 300,
 }
 
 JSON;
 
-var_dump(RelaxedJson::decode($text, true));
+var_dump(RelaxedJson::decode($json, true));
 ```
 
 ```txt
@@ -45,14 +45,15 @@ array(1) {
 ### exceptions
 
 ```php
-$text = <<<JSON
+$json = <<<JSON
 {
     "throttleThreshold" => 300,
 }
 
 JSON;
 
-var_dump(RelaxedJson::decode($text, true));
+// throws RelaxedJsonException Syntax error
+RelaxedJson::decode($json, true);
 ```
 
 ## credits

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "8ctopus/relaxed-json",
     "type": "library",
-    "description": "Tired of json's super strict syntax? Then relaxed json if for you.",
+    "description": "Tired of JSON's super strict syntax? Then relaxed JSON if for you.",
     "keywords": ["json", "json_decode", "json comment", "json comma", "invalid json", "lazy json", "relaxed json syntax", "json exception"],
     "homepage": "https://github.com/8ctopus/relaxed-json",
     "license": "MIT",