From 6dab7bee0b84576032db4d77d0bca081f2cca71a Mon Sep 17 00:00:00 2001 From: David Date: Fri, 2 Jun 2023 15:55:45 +0200 Subject: [PATCH] update docs --- CHANGELOG.md | 7 +++++++ README.md | 8 +++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 60c5848..5d94513 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,5 +4,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.2.0] - 2023-06-02 +### Added +- `Uri::withPathAdded(string $path)` has been added to allow adding path segments to an existing URI + +### Fixed +- User Info segment is now properly urlencoded according to RFC 3986 + ## [0.1.0] - 2022-12-28 - Initial release \ No newline at end of file diff --git a/README.md b/README.md index 19afb21..c1fd09d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # urimanage -A library to parse, format and modify URIs following the [PSR-7 URI interface](https://www.php-fig.org/psr/psr-7/]) +A library to parse, format and modify URIs following the [PSR-7 URI interface](https://www.php-fig.org/psr/psr-7/]), +with URL encoding according to RFC 3986. ## Installation Install via [composer](https://getcomposer.org): @@ -20,3 +21,8 @@ echo $uri->isAbsolute(); // true ## Full API Reference For a full reference of all available methods supported by PSR-7, please [see here](https://github.com/php-fig/http-message/blob/efd67d1dc14a7ef4fc4e518e7dee91c271d524e4/docs/PSR7-Interfaces.md#psrhttpmessageuriinterface-methods). + +### Additional methods +- `Uri::withPathAdded(string $path) : Uri` adds a path segment to the URI +- `Uri::isAbsolute() : bool` whether the URI is absolute (has scheme or authority) or not +- `Uri::getOriginalUri() : ?string` returns the original URI before any modifications \ No newline at end of file