Skip to content
This repository was archived by the owner on Sep 22, 2025. It is now read-only.

Commit 2ab2a92

Browse files
committed
Update README
1 parent f080b95 commit 2ab2a92

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
# A polyfill for PHP RFC 3986 and WHATWG compliant URI parsing support
1+
# A polyfill for PHP new native URI parsing feature
22

3-
This PHP polyfill provides:
3+
This package provides a PHP polyfill for PHP version greater or equal to **PHP8.1** to the new
4+
native PHP URI parsing features that are in discussion to be included in **PHP8.5**.
45

5-
- an [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986) compliant URI parsing
6-
- an [WHATWG URL](https://url.spec.whatwg.org/) compliant parsing
6+
The feature exposes:
77

8-
For PHP version greater or equal to **PHP8.1**.
8+
- an [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986) compliant URI parser using the `Uri\Rfc3986\Uri` class
9+
- an [WHATWG URL](https://url.spec.whatwg.org/) compliant parser using the `Uri\WhatWg\Url` class
910

1011
Documentation
1112
-------
1213

13-
Full documentation can be found on the [PHP RFC: Add RFC 3986 and WHATWG compliant URI parsing support](https://wiki.php.net/rfc/url_parsing_api).
14+
Full documentation can be found on the [Add RFC 3986 and WHATWG compliant URI parsing support RFC](https://wiki.php.net/rfc/url_parsing_api).
1415

1516
System Requirements
1617
-------
@@ -29,13 +30,20 @@ The URI polyfill has:
2930
- a [PHPUnit](https://phpunit.de) test suite
3031
- a code analysis compliance test suite using [PHPStan](https://github.com/phpstan/phpstan).
3132
- a coding style compliance test suite using [PHP CS Fixer](http://cs.sensiolabs.org/).
33+
- a benchmark using [PHP Bench](https://github.com/phpbench/phpbench).
3234

33-
To run the tests, run the following command from the project folder.
35+
To run the tests, run the following command from the project folder .
3436

3537
``` bash
3638
$ composer test
3739
```
3840

41+
You can run the benchmark separately using the following command:
42+
43+
``` bash
44+
$ composer benchmark
45+
```
46+
3947
Contributing
4048
-------
4149

0 commit comments

Comments
 (0)