From b81695be5d4fbc1c4d5253a64cb62be479221aa2 Mon Sep 17 00:00:00 2001
From: xdrm-brackets <doowap31@gmail.com>
Date: Sun, 4 Feb 2018 14:13:41 +0100
Subject: [PATCH] upd: 'README.md' -> new description, added 'trigger-wait' and
 'trigger-send'; TODO-README: read, write, pool, master; TODO-DEV:
 trigger-wait, trigger-send

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 45 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 852870d..6d7fa29 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,6 @@
 # bash socket utility
 
-## native calls
-
-### 1. bind-input
+## 1. Listen
 
 Binding an input creates a listening socket on a local port and binds the socket data to a local accessible buffer (accessible with the native `read` call).
 
@@ -62,7 +60,7 @@ kill -INT $bound_pid;
 
 
 
-### 2. bind-output
+## 2. Connect
 
 Binding an output creates a local accessible buffer (accessible with the native `write` call) bound to a socket connecting to a certain host and port.
 
@@ -104,3 +102,46 @@ write output1 "END";
 # 5. Kill 'bind-output' with signal SIGINT, SIGHUP or SIGTERM
 kill -INT $bound_pid;
 ```
+
+## 3. Network trigger
+
+The programs `trigger-send` and `trigger-wait` allows *signals* to be send over the network (private or public).
+- `trigger-wait` will wait for a signal to exit.
+- `trigger-send` will send a signal to a remote host.
+
+### **trigger-wait**
+
+```bash
+trigger-wait $key $port
+```
+
+*Arguments:*
+- `$key` is a secret string that the sender will have to match.
+- `$port` is the local listening port (between 1024 and 49151).
+
+*Exemple:*
+
+Let's say you want to wait for a signal on port 9999 then launch some command (for example `read input1`).
+
+```bash
+trigger-wait somekey123 9999; read input1;
+```
+
+### **trigger-send**
+
+```bash
+trigger-wait $key $host $port
+```
+
+*Arguments:*
+- `$key` is the same secret string used by the receiver.
+- `$host` is the remote hostname (IP addr. or resolvable) to send the messag eto.
+- `$port` is the remote port to send the message to (between 1024 and 49151).
+
+*Exemple:*
+
+Let's say you want to execute a long command (sleep 5), then send the trigger to 192.168.0.2 port 9999.
+
+```bash
+sleep 5; trigger-send somekey123 192.168.0.2 9999;
+```
\ No newline at end of file