Skip to content

Commit 44a5f84

Browse files
committed
doc : update
1 parent 0e76768 commit 44a5f84

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

+20-11
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,21 @@ Gobot is a powerful stateful API testing robot. It provides a graphical interfac
2020

2121
## Feature
2222

23-
* Use the `behavior tree` to control the running order of the robot, and use the `script` to control the specific behavior of the node (such as making an http request
24-
* SuProvides graphical editing and debugging capabilities
25-
* You can `prefab` template nodes in the configuration page, and `reuse` the nodes in the editor
26-
* It can be driven by http `api` (`post /bot.run -d '{"Name":"a robot"}'` can be easily integrated into CI
27-
* Supports multiple protocol formats (HTTP, TCP...
28-
* Support a `stress test` (you can set the number of concurrency on the configuration page
23+
* Utilizes the 'behavior tree' to control the robot's execution order and uses 'scripts' for specific node behaviors, such as making HTTP requests.
24+
* Provides graphical editing and debugging capabilities.
25+
* Allows creating and reusing 'prefab' template nodes in the configuration page.
26+
* Supports driving via HTTP API (post /bot.run -d '{"Name":"a robot"}'), making it easy to integrate into CI.
27+
* Supports multiple protocol formats (HTTP, TCP, etc.).
28+
* Offers 'stress testing' with configurable concurrency settings on the configuration page.
2929

3030

3131
## NodeScript
3232
> Through built-in modules and scripts, we can have rich logical expression capabilities. We can also use global (single bot) meta structures to maintain various state changes of the bot.
3333
```lua
3434
--[[
35-
Each node has its own independent .lua script. When the node is executed, dostring will be called to load and run this script.
35+
Each node has its own independent .lua script for execution. When a node is executed, the script is loaded and run using dostring.
36+
Users can load desired 'modules' into the script for additional functionalities. For more information, refer to the documentation.
37+
The script allows defining node execution logic, like sending an HTTP request.
3638
]]--
3739

3840
-- Users can load "modules" they want to use in the script.
@@ -61,10 +63,17 @@ end
6163
```
6264

6365
## Script Module
64-
|||||||
65-
|-|-|-|-|-|-|
66-
|`base64`|`http`|`tcp`|`protobuf`|`mongoDB`|`json`|
67-
|`md5`|`uuid`|`random`|...|
66+
| Module | interface |Description |
67+
|-------------|-------------|-------------|
68+
| base64 | `encode` `decode` |Provides base64 encoding/decoding functionality.|
69+
| http | `post` `get` `put` | Support HTTP connection. |
70+
| tcp | `dail` `close` `write` `read` | Support TCP connection. |
71+
| protobuf | `marshal` `unmarshal` | Provides Protobuf operations. |
72+
| mongoDB | `insert` `find` `update` `delete` ... | Provides MongoDB operations. |
73+
| json | `encode` `decode` | Offers JSON functionalities. |
74+
| md5 | `sum` | Calculates MD5 hashes. |
75+
| utils | `uuid` `random` | Generates random values, UUIDs. |
76+
| ... | More modules available. |
6877

6978
## Try it out
7079
Try the editor out [on website](http://178.128.113.58:31293)

0 commit comments

Comments
 (0)