Skip to content

Commit

Permalink
chore(docs): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
a-wing committed Apr 6, 2023
1 parent 832a4e0 commit ac333c5
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ config.yml
ncp
bin
coverage.txt
dist

/log/*
!/log/.keep
Expand Down
28 changes: 28 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [2.4.0] - 2023-04-06

### Add

* releaser deb
* add exec

exec system command. **NOTE: This is very dangerous!**

```yaml
- type: exec
params: "echo"
i_rules:
- regexp: '.*"method": ?"exec".*'
o_rules:
- regexp: '.*'
```
This `params` is command, example: `params: "/bin/sh"`

This Recvice JSONRPC, ignore `jsonrpc.method`. **jsonrpc.method is use of only match**

For example:

`params: "echo"`. jsonrpc2 `{"jsonrpc":"2.0","method":"exec","params":["-n", "xxx"],"id":"x"}`

Finally exec: `echo -n xxx`

## [2.3.0] - 2022-12-29

### Add
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ Type | Description
[API](#api) | build-in interface
[tcpc](#tcpc) | TCP socket client
[tcps](#tcps) | TCP socket server
[exec](#exec) | Execute system command
[jsonrpc2](#jsonrpc2)| JSONRPC 2.0 simulation
[logger](#logger) | Record message log
[mqtt](#mqtt) | Connect Mqtt Broker
Expand Down
1 change: 1 addition & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ Type | Description
[API](#api) | build-in interface
[tcpc](#tcpc) | TCP socket client
[tcps](#tcps) | TCP socket server
[exec](#exec) | Execute system command
[jsonrpc2](#jsonrpc2)| JSONRPC 2.0 simulation
[logger](#logger) | Record message log
[mqtt](#mqtt) | Connect Mqtt Broker
Expand Down

0 comments on commit ac333c5

Please # to comment.