X-Git-Url: http://git.osdn.net/view?a=blobdiff_plain;f=README.md;h=b33ad3642c1aba48c1a74e237bbabc3de90efff7;hb=77f9adc63a3410ef49033821ea1f8a4b4605e9d4;hp=d6b4fb7eba256c04b93699ea431b73d6f7dd6242;hpb=acbd5945228331b20dbf46d010301039750f8d30;p=php-libraries%2FRouter.git diff --git a/README.md b/README.md index d6b4fb7..b33ad36 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # PHP Router class +[![Latest Stable Version](https://poser.pugx.org/dannyvankooten/php-router/v/stable)](https://packagist.org/packages/dannyvankooten/php-router) +[![Total Downloads](https://poser.pugx.org/dannyvankooten/php-router/downloads)](https://packagist.org/packages/dannyvankooten/php-router) +[![Latest Unstable Version](https://poser.pugx.org/dannyvankooten/php-router/v/unstable)](https://packagist.org/packages/dannyvankooten/php-router) +[![License](https://poser.pugx.org/dannyvankooten/php-router/license)](https://packagist.org/packages/dannyvankooten/php-router) + A simple Rails inspired PHP router class. * Usage of different HTTP Methods @@ -14,19 +19,15 @@ A simple Rails inspired PHP router class. # Easy to install with **composer** -```javascript -{ - "require": { - "dannyvankooten/php-router": "dev-master" - } -} +```sh +$ composer require dannyvankooten/php-router ``` ## Usage ### Friendly URL -Create a simple .htaccess file on your root directory. +Create a simple .htaccess file on your root directory if you're using Apache with mod_rewrite enabled. ```apache Options +FollowSymLinks @@ -34,7 +35,34 @@ RewriteEngine On RewriteRule ^(.*)$ index.php [NC,L] ``` -It's a simple example of routers in action +If you're using nginx, setup your server section as following: + +```nginx +server { + listen 80; + server_name mydevsite.dev; + root /var/www/mydevsite/public; + + index index.php; + + location / { + try_files $uri $uri/ /index.php?$query_string; + } + + location ~ \.php$ { + fastcgi_split_path_info ^(.+\.php)(/.+)$; + # NOTE: You should have "cgi.fix_pathinfo = 0;" in php.ini + + # With php5-fpm: + fastcgi_pass unix:/var/run/php5-fpm.sock; + fastcgi_index index.php; + include fastcgi.conf; + fastcgi_intercept_errors on; + } +} +``` + +This is a simple example of routers in action ```php matchCurrentRequest(); ``` ## More information -Have a look at the example.php file or read trough the class' documentation for a better understanding on how to use this class. If you like PHP Router you might also like [AltoRouter](//github.com/dannyvankooten/AltoRouter). ## License + MIT Licensed, http://www.opensource.org/licenses/MIT