X-Git-Url: http://git.osdn.net/view?a=blobdiff_plain;f=README.md;h=1891efb0144dd85bc12550076552baaa33a4f5f1;hb=HEAD;hp=53382a6bc3c0db49ec2122ca832e3724643f6ad1;hpb=f10c21fc517c2b71e9649d4f7ce3c03aef551234;p=php-libraries%2FRouter.git diff --git a/README.md b/README.md index 53382a6..1891efb 100755 --- a/README.md +++ b/README.md @@ -14,19 +14,15 @@ A simple Rails inspired PHP router class. # Easy to install with **composer** -```javascript -{ - "require": { - "dannyvankooten/php-router": "dev-master" - } -} +```sh +$ composer require frostbane/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 +30,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 attachRoute(new Route('/users/', array( - '_controller' => 'someController::users_create', + '_controller' => 'someController::usersCreate', 'methods' => 'GET' ))); @@ -93,9 +116,9 @@ $router->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