From 52f99f680ab6ec740c963e6a590e06272a934e0a Mon Sep 17 00:00:00 2001
From: ha7ilm <retzlerandras@gmail.com>
Date: Thu, 19 Jan 2017 19:40:45 +0100
Subject: [PATCH] nmux: added docs

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index db2816d..e0f2ddc 100644
--- a/README.md
+++ b/README.md
@@ -515,6 +515,15 @@ To remove *sdr.js* and the compiled dependencies:
 
 	make emcc-clean
 
+## [nmux] (#nmux)
+
+The repo also contains a command line tool called `nmux`, which is a TCP stream multiplexer. It reads data from the standard input, and sends it to each client connected through TCP sockets. Available command line options are:
+* `--port (-p), --address (-a):` TCP port and address to listen.
+* `--bufsize (-b), --bufcnt (-n)`: Internal buffer size and count.
+* `--help (-h)`: Show help message.
+
+`nmux` was originally written for use in OpenWebRX.
+
 ## [Licensing] (#licensing)
 
 Most of the code of `libcsdr` is under BSD license.