Update readme (#112)

odan · web-flow · commit 89c6efdf8c32 · 2024-08-29T18:26:30.000+02:00
* Update readme. Fixes #110 * Update gitignore
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,18 @@
-.DS_Store
+# Composer
 composer.lock
-vendor
-.idea
-composer.phar
+/vendor
+
+# PHPUnit
+/.phpunit.cache
 .phpunit.result.cache
-build/
+
+# IDEs
+/.fleet
+/.idea
+/.vscode
+
+# Build artifacts and temporary files
+.DS_Store
+clover.xml
+/build
+/coverage
diff --git a/README.md b/README.md
@@ -183,9 +183,9 @@ The following function uses the `htmlspecialchars` function
 with specific flags to ensure proper encoding:
 
 ```php
-function html(string $text = null): string
+function html(?string $text = null): string
 {
-    return htmlspecialchars($text, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
+    return htmlspecialchars($text ?? '', ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
 }
 ```
 

Original file line number	Diff line number	Diff line change
@@ -183,9 +183,9 @@ The following function uses the `htmlspecialchars` function
`183`	`183`	`with specific flags to ensure proper encoding:`
`184`	`184`
`185`	`185`	```php
`186`		`-function html(string $text = null): string`
	`186`	`+function html(?string $text = null): string`
`187`	`187`	`{`
`188`		`- return htmlspecialchars($text, ENT_QUOTES \| ENT_SUBSTITUTE, 'UTF-8');`
	`188`	`+ return htmlspecialchars($text ?? '', ENT_QUOTES \| ENT_SUBSTITUTE, 'UTF-8');`
`189`	`189`	`}`
`190`	`190`	```
`191`	`191`