You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2022/07/29 16:58:53 UTC

[plc4x] branch develop updated: chore: update documentation [skip ci]

This is an automated email from the ASF dual-hosted git repository.

sruehl pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git


The following commit(s) were added to refs/heads/develop by this push:
     new 0002837f9 chore: update documentation [skip ci]
0002837f9 is described below

commit 0002837f9a894f9e2e31f711ae513aaa9fc55a89
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Fri Jul 29 18:58:45 2022 +0200

    chore: update documentation [skip ci]
---
 plc4go/README.md | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/plc4go/README.md b/plc4go/README.md
index 57966a946..e746a2e27 100644
--- a/plc4go/README.md
+++ b/plc4go/README.md
@@ -27,5 +27,16 @@ To use plc4go import `"github.com/apache/plc4x/plc4go/pkg/api"` and use the driv
 
 ## plc4go tools
 
-To install a tool e.g. `plc4xpcapanalyzer` install it like that: 
-`go install github.com/apache/plc4x/plc4go/tools/plc4xpcapanalyzer@latest`
\ No newline at end of file
+### plc4xpcapanalyzer
+
+`plc4xpcapanalyzer` is a small tool to evaluate the plc4x parsing against a pcap and report the success rate.
+
+To install `plc4xpcapanalyzer` run: 
+`go install github.com/apache/plc4x/plc4go/tools/plc4xpcapanalyzer@latest`
+
+### plc4xbrowser
+
+`plc4xbrowser` is a terminal application to run `REPL`-commands against a PLC using plc4x (plc4go)
+
+To install `plc4xbrowser` run: 
+`go install github.com/apache/plc4x/plc4go/tools/plc4xbrowser@latest`