Merge pull request #1 from swooletw/master

merge readme.md

Author: albertcht

README.md

@@ -1,21 +1,27 @@
 # Laravel-Swoole
 
-This package provides a high performance HTTP server which based on [Swoole](http://www.swoole.com/).
+![php-badge](https://img.shields.io/badge/php-%3E%3D%205.5.9-8892BF.svg)
+[![packagist-badge](https://img.shields.io/packagist/v/swooletw/laravel-swoole.svg)](https://packagist.org/packages/swooletw/laravel-swoole)
+[![Total Downloads](https://poser.pugx.org/swooletw/laravel-swoole/downloads)](https://packagist.org/packages/swooletw/laravel-swoole)
+
+This package provides a high performance HTTP server to speed up your laravel/lumen application based on [Swoole](http://www.swoole.com/).
 
 ## Version Compatibility
 
 | PHP     | Laravel | Lumen | Swoole  |
 |:-------:|:-------:|:-----:|:-------:|
 | >=5.5.9 | ~5.1    | ~5.1  | >=1.9.3 |
 
-## Quick Start
+## Installation
 
 Require this package with composer by using the following command:
 
 ```
 $ composer require swooletw/laravel-swoole
 ```
 
+> This package relies on Swoole. Please make sure your machine has been installed the Swoole extension. Using this command to install quickly: `pecl install swoole`. Visit the [official website](https://wiki.swoole.com/wiki/page/6.html) for more information.
+
 Then, add the service provider:
 
 If you are using Laravel, add the service provider to the providers array in `config/app.php`:
@@ -34,13 +40,70 @@ If you are using Lumen, append the following code to `bootstrap/app.php`:
 $app->register(SwooleTW\Http\LumenServiceProvider::class);
 ```
 
+## Configuration
+
+If you want to change the default configurations, please run the following command to generate a configuration file `http.php` in directory `config/`:
+
+```
+$ php artisan vendor:publish
+```
+
+`server.host`: The swoole_http_server host.
+
+`server.port`: The swoole_http_server port.
+
+`server.options`: The configurations for `Swoole\Server`. To get more information about swoole server, please read [the official documentation](https://wiki.swoole.com/wiki/page/274.html).
+
+For example, if you want to set the 'max_request':
+
+```php
+[
+    'server' => [
+        'options' => [
+            'max_request' => 1000,
+        ],
+    ]
+]
+```
+
+## Command
+
+> The swoole_http_server can only run in cli environment, and this package provides convenient artisan commands to manage it.
+> By default, you can visit your site at http://127.0.0.1:1215
+
+Start the swoole_http_server:
+
+```
+$ php artisan swoole:http start
+```
+
+Stop the swoole_http_server:
+
+```
+$ php artisan swoole:http stop
+```
+
+Restart the swoole_http_server:
+
+```
+$ php artisan swoole:http restart
+```
+
+Reload the swoole_http_server:
+
+```
+$ php artisan swoole:http reload
+```
+
 Now, you can run the following command to start the **swoole_http_server**.
 
 ```
 $ php artisan swoole:http start
 ```
 
-By default, you can visit your site at http://127.0.0.1:1215. And you can also configure domains via nginx proxy:
+## Nginx Configuration
+
+> The support of swoole_http_server for Http is not complete. So, you should configure the domains via nginx proxy in your production environment.
 
 ```nginx
 server {
@@ -50,7 +113,8 @@ server {
     index index.php;
 
     location = /index.php {
-        # Ensure that there is no such file named "not_exists" in your "public" directory.
+        # Ensure that there is no such file named "not_exists"
+        # in your "public" directory.
         try_files /not_exists @swoole;
     }
 
@@ -60,11 +124,11 @@ server {
 
     location @swoole {
         set $suffix "";
-        
+
         if ($uri = /index.php) {
             set $suffix "/";
         }
-    
+
         proxy_set_header Host $host;
         proxy_set_header SERVER_PORT $server_port;
         proxy_set_header REMOTE_ADDR $remote_addr;
@@ -78,15 +142,55 @@ server {
 }
 ```
 
-## Documentation
+## Performance Reference
+
+Test with clean Lumen 5.5, using MacBook Air 13, 2015.
+Benchmarking Tool: [wrk](https://github.com/wg/wrk)
+
+```
+wrk -t4 -c100 http://your.app
+```
+
+### Nginx with FPM
 
-- [English](docs/english.md)
-- [简体中文](docs/chinese.md)
+```
+Running 10s test @ http://lumen.app:9999
+  4 threads and 100 connections
+  Thread Stats   Avg      Stdev     Max   +/- Stdev
+    Latency     1.14s   191.03ms   1.40s    90.31%
+    Req/Sec    22.65     10.65    50.00     65.31%
+  815 requests in 10.07s, 223.65KB read
+Requests/sec:     80.93
+Transfer/sec:     22.21KB
+```
+
+### Swoole HTTP Server
+
+```
+Running 10s test @ http://127.0.0.1:1215
+  4 threads and 100 connections
+  Thread Stats   Avg      Stdev     Max   +/- Stdev
+    Latency    11.58ms    4.74ms  68.73ms   81.63%
+    Req/Sec     2.19k   357.43     2.90k    69.50%
+  87879 requests in 10.08s, 15.67MB read
+Requests/sec:   8717.00
+Transfer/sec:      1.55MB
+```
+
+## Notices
+
+1. Please reload or restart the swoole_http_server after released your code. Because the Laravel program will be kept in memory after the swoole_http_server started. That's why the swoole_http_server has high performance.
+2. Never use `dd()`, `exit()` or `die()` function to print your debug message. It will terminate your swoole worker unexpectedly.
+3. You should have basic knowledge of multi-process programming and swoole. If you still write your code with a single-process conception, your app might have unexpected bugs.
 
 ## Support
 
 Bugs and feature request are tracked on [Github](https://github.com/swooletw/laravel-swoole-http/issues).
 
+## Credits
+
+The original author of this package: [Huang-Yi](https://github.com/huang-yi)
+
 ## License
 
-The Laravel-Swoole-Http package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
+The Laravel-Swoole-Http package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).