update

Author: ShixiangWang

README.md

@@ -1,4 +1,4 @@
-# HiSub: a tool generating Hiplot plugin from R script
+# HiSub: generate Hiplot native plugin from R script
 
 Hiplot plugin (self-contained Apps generated by Shiny or other techniques are not included) uses JSON to communicate with the front end, it is not easy to code and maintain both R script and JSON files at the same time. In current stage, a formal Hiplot plugin has the following structure in a directory:
 
@@ -38,7 +38,7 @@ For better use this tools, I recommend you to generate a soft link to the `hisub
 ln -s ~/Documents/GitHub/hiplot-plugin-generator/hisub.R ~/.local/bin/hisub
 ```
 
-Change the first path to your clone `hisub.R` path and change the second path to a path store executable file.
+Change the first path to your cloned `hisub.R` path and change the second path to a path storing the executable file.
 NOTE, the second path should be in system `PATH` variable so you can call **HiSub** with `hisub`.
 
 ### Hello World
@@ -121,13 +121,14 @@ With the R script, we can generate the Hiplot plugin with command:
 ./hisub.R examples/helloworld.R test_hello
 ```
 
-**HiSub** accept as many as parameters you can put, but only the first and the last arguments will be used.
+**HiSub** accept as many as parameters you can put, but only the first will be treated as the R script to parse
+
+Others:
 
-- The 1st argument should be the prepared R script file.
 - The last argument should be a directory path for the plugin, typically it has the same name as your plugin name.
 - Other middle arguments will be treated as necessary files (like `README.md`, currently it cannot be scripts called by the 1st R script ) and copied to the destination directory (specified by the last argument).
 
-Then you can submit the generated `data.json` and `ui.json` to https://hiplot.com.cn/developer/plugin-preview to see how it works. For our "Hello World", it looks like:
+Then you can submit the generated `data.json` and `ui.json` to <https://hiplot.com.cn/developer/plugin-preview> (You can also read exmaples provided by this link and see how to set the parameter settings) to see how it works. For our "Hello World", it looks like:
 
 ![image-20210204202229053](https://gitee.com/ShixiangWang/ImageCollection/raw/master/png/20210204202229.png)
 
@@ -172,6 +173,6 @@ This section I will briefly describe supported tags, for more information, pleas
 
 ### Docs
 
-We are preparing, read <https://hiplot.com.cn/docs/zh/development-guides/> for now.
+See [doc.md](doc.md)
 
 &copy; 2020 Hiplot team

doc.md

@@ -39,13 +39,20 @@
 
 ## 通用参数
 
-一般是为 ggplot2 设定的
+一般是为 ggplot2 设定的。
 ## Vue 控件类型
 
 `<param-type>::<widget-type>::<param_setting>`
 
-vue 控件类型和常用参数
+Vue 控件类型和常用参数
 
 ## 全局变量
 
-conf 和 opt 这两个全局变量
+`conf` 和 `opt` 这两个全局变量，可以直接使用。
+
+`conf`为最常用的一个，里面包含了从`data.json`中解析出来的插件参数。
+
+## More
+
+https://hiplot.com.cn/docs/zh/development-guides/
+