Readme and help

README.md

@@ -1 +1,36 @@
-# muxd
+# muxd
+
+Multi-purpose utility for converting network traffic
+
+Usage:
+```
+./muxd --input-protocol tcp --input-host 127.0.0.1 --input-port 8080 --output-protocol udp --output-host myserver.example.com --output-port 12345 --debug
+```
+
+Help:
+```
+NAME:
+   muxd - Network multiplexer
+
+USAGE:
+   muxd [global options] command [command options] [arguments...]
+
+VERSION:
+   0.0.1
+
+COMMANDS:
+     help, h  Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --input-protocol value   Input protocol [tcp, udp, redis]
+   --input-host value       Input host (IP)
+   --input-port value       Input port (default: 0)
+   --input-channel value    Input channel [redis]
+   --output-protocol value  Output protocol [tcp, udp, redis]
+   --output-host value      Output host (IP)
+   --output-port value      Output port (default: 0)
+   --output-channel value   Output channel [redis]
+   --debug                  Set debug log level
+   --help, -h               show help
+   --version, -v            print the version
+   ```

main.go

@@ -4,6 +4,7 @@ import (
 	"os"
 
 	"github.com/ahmbas/muxd/mux"
+
 	log "github.com/sirupsen/logrus"
 	"github.com/urfave/cli"
 	prefixed "github.com/x-cray/logrus-prefixed-formatter"
@@ -14,7 +15,7 @@ func init() {
 	formatter.FullTimestamp = true
 	log.SetFormatter(formatter)
 	log.SetOutput(os.Stdout)
-	log.SetLevel(log.DebugLevel)
+	log.SetLevel(log.WarnLevel)
 }
 
 func main() {
@@ -27,8 +28,11 @@ func main() {
 	var outputHost string
 	var outputPort int
 	var outputChannel string
+	var debugLevel bool
 
 	app := cli.NewApp()
+	app.Version = "0.0.1"
+	app.Usage = "Network multiplexer"
 
 	app.Flags = []cli.Flag{
 		cli.StringFlag{
@@ -79,9 +83,18 @@ func main() {
 			Usage:       "Output channel [redis]",
 			Destination: &outputChannel,
 		},
+		cli.BoolFlag{
+			Name:        "debug",
+			Usage:       "Set debug log level",
+			Destination: &debugLevel,
+		},
 	}
 	app.Action = func(c *cli.Context) error {
 
+		if debugLevel {
+			log.SetLevel(log.DebugLevel)
+		}
+
 		inputOpts := mux.Opts{
 			Protocol: inputProtocol,
 			Host:     inputHost,

mux/mux.go

@@ -56,7 +56,7 @@ func GetConnection(o Opts) protocols.BaseConnection {
 			Port:     o.Port,
 		}
 	default:
-		fmt.Printf("%v protocol not supported. Yet\n", o.Protocol)
+		fmt.Printf("Invalid args. Run with --help")
 		os.Exit(1)
 	}
 	return nil