diff --git a/README.md b/README.md index ec7d09d..3e97a40 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,25 @@ This package contains an interface to represents URI objects according to [RFC 3 > ⚠️ this is a sub-split, for development, pull requests and issues, visit: https://github.com/thephpleague/uri-src + System Requirements ------- -You need: +You require **PHP >= 8.1** but the latest stable version of PHP is recommended + +Handling of an IDN host requires the presence of the `intl` +extension or a polyfill for the `intl` IDN functions like the +`symfony/polyfill-intl-idn` otherwise an exception will be thrown +when attempting to validate or interact with such a host. + +IPv4 conversion requires at least one of the following: + +- the `GMP` extension, +- the `BCMatch` extension or +- a `64-bits` PHP version -- **PHP >= 8.1** but the latest stable version of PHP is recommended +otherwise an exception will be thrown when attempting to convert a host +as an IPv4 address. Install -------- @@ -22,97 +35,9 @@ $ composer require league/uri-interfaces Documentation -------- -### League\Uri\Contract\UriInterface - -The `UriInterface` interface models generic URIs as specified in [RFC 3986](http://tools.ietf.org/html/rfc3986). -The interface provides methods for interacting with the various URI parts, which will obviate the need for repeated parsing of the URI. -It also specifies: - -- a `__toString()` method for casting the modeled URI to its string representation. -- a `jsonSerialize()` method to improve interoperability with [WHATWG URL Living standard](https://url.spec.whatwg.org/) - -#### Accessing URI properties - -The `UriInterface` interface defines the following methods to access the URI string representation, its individual parts and components. - -~~~php -