Update README.md

README.md

@@ -1,7 +1,7 @@
 workerman
 =========
 
-workerman 是一个高性能的PHP Rpc服务框架，开发者可以在这个框架下开发各种网络应用。
+workerman 是一个高性能的PHP socket服务框架，开发者可以在这个框架下开发各种网络应用,例如Rpc服务、聊天室、游戏等。
 workerman 具有以下特性
  * 多进程
  * 支持TCP/UDP
@@ -24,11 +24,14 @@ workerman不能运行在Window平台
 =========
 
 以ubuntu为例
-安装PHP Cli
+
+安装PHP Cli  
 `sudo apt-get install php5-cli`
-强烈建议安装libevent扩展，以便支持更高的并发量
+
+强烈建议安装libevent扩展，以便支持更高的并发量  
 `sudo pecl install libevent`
-建议安装proctitle扩展(php5.5及以上版本原生支持，无需安装)，以便方便查看进程信息
+
+建议安装proctitle扩展(php5.5及以上版本原生支持，无需安装)，以便方便查看进程信息  
 `sudo pecl install proctitle`
 
 
@@ -37,29 +40,29 @@ workerman不能运行在Window平台
 
 以ubuntu为例
 
-启动
-sudo ./bin/workermand start
+启动  
+`sudo ./bin/workermand start`
 
-重启启动
-sudo ./bin/workermand restart
+重启启动  
+`sudo ./bin/workermand restart`
 
-平滑重启/重新加载配置
-sudo ./bin/workermand reload
+平滑重启/重新加载配置  
+`sudo ./bin/workermand reload`
 
-查看服务状态
-sudo ./bin/workermand status
+查看服务状态  
+`sudo ./bin/workermand status`
 
-停止
-sudo ./bin/workermand stop
+停止  
+`sudo ./bin/workermand stop`
 
-Rpc应用客户端使用方法
+Rpc应用使用方法
 =========
 
-同步调用：
+ * 客户端同步调用：
 
 ```php
 <?php
-include_once 'yourdir/RpcClient.php';
+include_once 'yourClientDir/RpcClient.php';
 
 $address_array = array(
           'tcp://127.0.0.1:2015',
@@ -78,34 +81,89 @@ $ret_sync = $user_client->getInfoByUid($uid);
 
 ```
 
-异步调用：
+ * 客户端异步调用：
 RpcClient支持异步远程调用
 
 ```php
 <?php
- // 服务端列表
-    $address_array = array(
-            'tcp://127.0.0.1:2015',
-            'tcp://127.0.0.1:2015'
-            );
-    // 配置服务端列表
-    RpcClient::config($address_array);
-    
-    $uid = 567;
-    $user_client = RpcClient::instance('User');
+include_once 'yourClientDir/RpcClient.php';
+// 服务端列表
+$address_array = array(
+  'tcp://127.0.0.1:2015',
+  'tcp://127.0.0.1:2015'
+  );
+// 配置服务端列表
+RpcClient::config($address_array);
+
+$uid = 567;
+$user_client = RpcClient::instance('User');
+
+// 异步调用User::getInfoByUid方法
+$user_client->asend_getInfoByUid($uid);
+// 异步调用User::getEmail方法
+$user_client->asend_getEmail($uid);
+
+这里是其它的业务代码
+....................
+....................
+
+// 需要数据的时候异步接收数据
+$ret_async1 = $user_client->arecv_getEmail($uid);
+$ret_async2 = $user_client->arecv_getInfoByUid($uid);
+
+这里是其他业务逻辑
+
+```
+
+ * 服务端：  
+服务端每个类提供一组服务，类文件默认放在workerman/applications/Rpc/Services目录下。  
+客户端实际上是远程调用这些类的静态方法。
+例如：
+```php
+<?php
+RpcClient::instance('User')->getInfoByUid($uid);
+```
+调用的是workerman/applications/Rpc/Services/User.php 中 User类的getInfoByUid方法。    
+User.php文件类似这样
+```php
+<?php
+class User
+{
+       public static function getInfoByUid($uid)
+        {
+            // ....
+        }
    
-    // 异步调用User::getInfoByUid方法
-    $user_client->asend_getInfoByUid($uid);
-    // 异步调用User::getEmail方法
-    $user_client->asend_getEmail($uid);
-
-     这里是其它的业务代码
-     ....................
-     ....................
-     
-    // 需要数据的时候异步接收数据
-    $ret_async1 = $user_client->arecv_getEmail($uid);
-    $ret_async2 = $user_client->arecv_getInfoByUid($uid);
-    
-     这里是其他业务逻辑
+        public static function getEmail($uid)
+        {
+            // ...
+        }
+}
+```
 
+如果你想要增加一组服务，可以在这个目录下增加类文件即可。
+
+
+配置
+========
+
+ * 配置文件在workerman/conf/目录下  
+ * 其中workerman/conf/workerman.conf是workerman的主体配置文件，在里面可以设置运行模式、日志目录、pid文件存储位置等配置  
+ * workerman/conf/conf.d/下每个配置文件对应一个网络应用，同时也对应workerman\workers下的一组worker进程。
+ * 以Rpc网络服务应用的配置文件workerman/conf/conf.d/RpcWorker.conf为例
+
+```
+;Rpc网络服务应用配置
+;所用的传输层协议及绑定的ip端口
+listen = tcp://0.0.0.0:2015
+;长连接还是短连接，Rpc服务这里设置成短连接，每次请求后服务器主动断开
+persistent_connection = 0
+;启动多少worker进程，这里建议设置成cpu核数的整数倍，例如 CPU数*3
+start_workers=12
+;接收多少请求后退出该进程，重新启动一个新进程，设置成0代表永不重启
+max_requests=1000
+;以哪个用户运行该worker进程，建议使用权限较低的用户运行worker进程，例如www-data
+user=www-data
+;socket有数据可读的时候预读长度，一般设置为应用层协议包头的长度，这里设置成尽可能读取更多的数据
+preread_length=84000
+```