diff --git a/Res/ChannelLinterUsage.md b/Res/ChannelLinterUsage.md index 0a582b5..3abd2f2 100644 --- a/Res/ChannelLinterUsage.md +++ b/Res/ChannelLinterUsage.md @@ -18,4 +18,43 @@ Options: parameters from Capability/create/arguments arrays. -x [ARGS... ], --command [ARGS... ] Execute a command with a given and arguments [ARGS...] +``` + +Below is an example of a **Failed** run of a channel, note the exception. This information tells us that an incorrect character was passed to the base64 decoder. The cause of this was lack of URL Encoding. + +``` +.\ChannelLinter_r86.exe -n Trello -a "input" "output" "KEY" "TOKEN" "linterTest1" -i +Custom Command and Control - Channel linter. BUILD: C3-1.0.manual-build +Channel: Trello +Parsing create arguments ... OK +Parsing command definitions ... OK +Registered commands: +id name +65534 Set UpdateDelayJitter +65535 Close +Trello's Capability json verified OK. +Creating channel ... OK +Creating complementary channel ... OK +Testing channel with 8 bytes of data ... parse error: character [32 ' '] out of bounds +``` + +Once fixed, a successful run is observed: + +``` + .\ChannelLinter_r86.exe -n Trello -a "input" "output" "KEY" "TOKEN" "linterTest1" -i +Custom Command and Control - Channel linter. BUILD: C3-1.0.manual-build +Channel: Trello +Parsing create arguments ... OK +Parsing command definitions ... OK +Registered commands: +id name +65534 Set UpdateDelayJitter +65535 Close +Trello's Capability json verified OK. +Creating channel ... OK +Creating complementary channel ... OK +Testing channel with 8 bytes of data ... OK +Testing channel with 64 bytes of data ... OK +Testing channel with 1024 bytes of data ... OK +Testing channel with 1048576 bytes of data ... OK ``` \ No newline at end of file