Skip to content

Commit 243fa36

Browse files
committed
adds readme and changelog
1 parent 00d9cac commit 243fa36

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [0.1.0] - 2022-12-28
8+
- Initial release

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# urimanage
2+
A library to parse, format and modify URIs following the [PSR-7 URI interface](https://www.php-fig.org/psr/psr-7/])
3+
4+
## Installation
5+
Install via [composer](https://getcomposer.org):
6+
```
7+
composer require urimanage/urimanage
8+
```
9+
10+
## Simple Usage
11+
```php
12+
$uri = new \UriManage\Uri('https://github.com/filecage/urimanage');
13+
14+
echo $uri->getScheme(); // https
15+
echo $uri->getHost(); // github.com
16+
echo $uri->getPath(); // /filecage/urimanage
17+
echo $uri->isAbsolute(); // true
18+
```
19+
20+
## Full API Reference
21+
For a full reference of all available methods supported by PSR-7, please
22+
[see here](https://github.com/php-fig/http-message/blob/efd67d1dc14a7ef4fc4e518e7dee91c271d524e4/docs/PSR7-Interfaces.md#psrhttpmessageuriinterface-methods).

0 commit comments

Comments
 (0)