doc: add examples

README.md

@@ -14,23 +14,47 @@ tars2node [OPTIONS] tarsfile
 
 ## 选项
 
-> Options:
+| 选项 | 作用 |
->  --version                    print tars2node version.  
+| ------------- | ------------- |
->  --rpc-path=[DIRECTORY]       specify the path of rpc module.  
+| --stream-path=[DIRECTORY]  | 指定编解码模块名称，默认为 @tars/stream。 |
->  --stream-path=[DIRECTORY[]   specify the path of stream module.  
+| --rpc-path=[DIRECTORY]     | 指定 RPC 模块名称，默认为 @tars/rpc。 |
->  --allow-reserved-namespace   allow you to use reserved word as a namespace.  
+| --allow-reserved-namespace | 是否允许 `tars` 作为命名空间（因为此命名空间主要用于框架服务的 tars 文件定义）。 |
->  --dir=DIRECTORY              generate source file to DIRECTORY.  
+| --dir=[DIRECTORY]          | 生成文件的输出目录。 |
->  --relative                   use current path.  
+| --relative                 | 限定所有的 `.tars` 文件都在当前目录寻找。|
->  --tarsBase=DIRECTORY          where to search tars files.  
+| --tarsBase=[DIRECTORY]     | 指定 `.tars` 文件的搜索目录。|
->  --r                          generate source all tars files.  
+| --r                        | 转换嵌套的 `.tars` 文件。|
->  --r-minimal                  minimize the dependent members.  
+| --r-minimal                | 精简依赖文件，移除非必须成员。|
->  --r-reserved                 list of names(split by ",") that should be keeped.  
+| --r-reserved               | 精简依赖文件时需保留的成员。|
->  --client                     just for client side source file.  
+| --client                   | 生成客户端的调用类代码。|
->  --server                     just for server side source file.  
+| --server                   | 生成服务端的框架代码。|
->  --dts                        generate d.ts file.  
+| --dts                      | 生成时附加 TypeScript 描述文件（.d.ts）。|
->  --use-string-represent       use string represent long type.  
+| --use-string-represent     | 当需要保持 <long> 类型的精度时，打开此选项使用 \<string\> 存储 \<long\>。|
->  --string-binary-encoding     get string raw bytes <BinBuffer>.  
+| --string-binary-encoding   | 遇到字符编码问题或需对原始数据进行存取时，打开此选项使用 \<buffer\> 存储 \<string\>。|
->  --optimize=[0|s]             support "s" to reduce code size, default is 0.  
+| --optimize=[0\|s]          | 优化输出代码大小，默认为 0（也就是不优化）。|
+
+## 例子
+
+```bash
+tars2node Protocol.tars
+```
+
+上述命令将转换 `Protocol.tars` 文件中定义的 `常量`、`枚举`、`结构体` 等数据类型生成 `ProtocolTars.js` 供编解码使用。
+使用方法请参考 [@tars/stream](https://www.npmjs.com/package/@tars/stream) 模块说明文档。
+
+```bash
+tars2node Protocol.tars --client
+```
+
+上述命令将转换文件中定义的 `常量`、`枚举值`、`结构体` 等数据类型，并将 `interface` 描述段转换为 Tars RPC 客户端接口文件，最终生成 `ProtocolProxy.js` 供调用方使用。
+使用方法请参考 [@tars/rpc](https://www.npmjs.com/package/@tars/rpc) 模块说明文档。
+
+```bash
+tars2node Protocol.tars --server
+```
+
+上述命令将转换文件中定义的 `常量`、`枚举值`、`结构体` 等数据类型，并将 `interface` 描述段转换为 Tars RPC 服务端接口文件，最终生成 `Protocol.js` 以及 `ProtocolImp.js` 供服务提供方使用。
+开发者无需改动 `Protocol.js`，只需要继续完善 `ProtocolImp.js` 实现文件中具体的函数，即可作为 Tars RPC 服务端提供服务。
+使用方法请参考 [@tars/rpc](https://www.npmjs.com/package/@tars/rpc) 模块说明文档。
 
 ## 从源码编译