From 157d80cd88901b20165dd49f48df1128981b6756 Mon Sep 17 00:00:00 2001
From: Lucas BEE <pouulet@gmail.com>
Date: Sun, 24 Jul 2016 22:43:38 +0000
Subject: [PATCH] Add readme

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b1e6ce2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Exec in network
+
+[![Build Status](https://travis-ci.org/PouuleT/exec-in-net.svg?branch=master)](https://travis-ci.org/PouuleT/exec-in-net)
+[![Go Report Card](https://goreportcard.com/badge/github.com/PouuleT/exec-in-net)](https://goreportcard.com/report/github.com/PouuleT/exec-in-net)
+
+> Execute any commands within a network namespace with its own IP and route
+
+## Usage
+
+```
+  -command string
+      command to be executed (default "ip route")
+  -gw string
+      gateway of the network
+  -interface string
+      interface used to get out of the network (default "eth0")
+  -ip string
+      IP network from where the command will be executed (default "192.168.1.11/24")
+  -log-level string
+      min level of logs to print (default "info")
+  -ns-path string
+      path of the temporary namespace to be created (default "/var/run/netns/w000t$PID")
+
+```