Skip to content

Commit a7f2dff

Browse files
committed
docs: updated readme
1 parent 759ac25 commit a7f2dff

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
## Router
2+
23
```
3-
_____ _ _ _____ _____ _
4-
| __ \| | | | __ \ | __ \ | |
4+
_____ _ _ _____ _____ _
5+
| __ \| | | | __ \ | __ \ | |
56
| |__) | |__| | |__) | ______ | |__) |___ _ _| |_ ___ _ __
67
| ___/| __ | ___/ |______| | _ // _ \| | | | __/ _ \ '__|
7-
| | | | | | | | | \ \ (_) | |_| | || __/ |
8-
|_| |_| |_|_| |_| \_\___/ \__,_|\__\___|_|
8+
| | | | | | | | | \ \ (_) | |_| | || __/ |
9+
|_| |_| |_|_| |_| \_\___/ \__,_|\__\___|_|
910
1011
```
12+
1113
**PHP Router**, which also has rich features like Middlewares and Controllers is simple and useful router class for PHP.
1214

1315
![Tests](https://github.com/izniburak/php-router/actions/workflows/run-tests.yml/badge.svg)
@@ -17,6 +19,7 @@
1719
[![License](https://poser.pugx.org/izniburak/router/license.svg)](https://packagist.org/packages/izniburak/router)
1820

1921
### Features
22+
2023
- Supports GET, POST, PUT, DELETE, OPTIONS, PATCH, HEAD, AJAX and ANY request methods
2124
- Easy access and manage Request and Response via `symfony/http-foundation` package.
2225
- Controllers support (Example: HomeController@about)
@@ -39,19 +42,23 @@ $ composer require izniburak/router
3942
```
4043

4144
OR you can add following lines into the `composer.json` file manually:
45+
4246
```json
4347
{
44-
"require": {
45-
"izniburak/router": "^2.0"
46-
}
48+
"require": {
49+
"izniburak/router": "^3.0"
50+
}
4751
}
4852
```
53+
4954
Then, run the following command:
55+
5056
```
5157
$ composer install
5258
```
5359

5460
## Example Usage
61+
5562
```php
5663
require 'vendor/autoload.php';
5764

@@ -80,16 +87,19 @@ $router->run();
8087
```
8188

8289
## Docs
90+
8391
Documentation page: [Buki\Router Docs][doc-url]
8492

8593
Changelogs: [Buki\Router Changelogs][changelog-url]
8694

8795
## Support
96+
8897
[izniburak's homepage][author-url]
8998

9099
[izniburak's twitter][twitter-url]
91100

92101
## Licence
102+
93103
[MIT Licence][mit-url]
94104

95105
## Contributing

0 commit comments

Comments
 (0)