Skip to content

Commit d3c2bbd

Browse files
committed
Updated README.md
1 parent 71dd750 commit d3c2bbd

File tree

1 file changed

+66
-1
lines changed

1 file changed

+66
-1
lines changed

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
1-
# router
1+
## Router
22
simple router class for php
3+
4+
[![Total Downloads](https://poser.pugx.org/izniburak/pdox-orm/d/total.svg)](https://packagist.org/packages/izniburak/router)
5+
[![Latest Stable Version](https://poser.pugx.org/izniburak/pdox-orm/v/stable.svg)](https://packagist.org/packages/izniburak/router)
6+
[![Latest Unstable Version](https://poser.pugx.org/izniburak/pdox-orm/v/unstable.svg)](https://packagist.org/packages/izniburak/router)
7+
[![License](https://poser.pugx.org/izniburak/pdox-orm/license.svg)](https://packagist.org/packages/izniburak/router)
8+
9+
## Install
10+
11+
composer.json file:
12+
```json
13+
{
14+
"require": {
15+
"izniburak/router": "dev-master"
16+
}
17+
}
18+
```
19+
after run the install command.
20+
```
21+
$ composer install
22+
```
23+
24+
OR run the following command directly.
25+
26+
```
27+
$ composer require izniburak/router:dev-master
28+
```
29+
30+
## Example Usage
31+
```php
32+
require 'vendor/autoload.php';
33+
34+
$router = new \Buki\Router();
35+
36+
$router->get('/', function() {
37+
return 'Hello World!';
38+
});
39+
```
40+
41+
## Docs
42+
Documentation page: [Buki\Router Docs][doc-url]
43+
44+
## Support
45+
[izniburak's homepage][author-url]
46+
47+
[izniburak's twitter][twitter-url]
48+
49+
## Licence
50+
[MIT Licence][mit-url]
51+
52+
## Contributing
53+
54+
1. Fork it ( https://github.com/izniburak/router/fork )
55+
2. Create your feature branch (git checkout -b my-new-feature)
56+
3. Commit your changes (git commit -am 'Add some feature')
57+
4. Push to the branch (git push origin my-new-feature)
58+
5. Create a new Pull Request
59+
60+
## Contributors
61+
62+
- [izniburak](https://github.com/izniburak) İzni Burak Demirtaş - creator, maintainer
63+
64+
[mit-url]: http://opensource.org/licenses/MIT
65+
[doc-url]: https://github.com/izniburak/router/blob/master/DOCS.md
66+
[author-url]: http://burakdemirtas.org
67+
[twitter-url]: https://twitter.com/izniburak

0 commit comments

Comments
 (0)