Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
filecage committed Jun 2, 2023
1 parent d67f051 commit 6dab7be
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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):
Expand All @@ -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

0 comments on commit 6dab7be

Please sign in to comment.