From b0069b74f678454cef7c745d5c19544b8d8deaee Mon Sep 17 00:00:00 2001
From: Philippe PITTOLI <p.pittoli@unistra.fr>
Date: Tue, 8 Oct 2019 01:21:27 +0200
Subject: [PATCH] readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2ddbd83
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# networkctl
+
+This software replaces networkmanager.
+
+Usage:
+
+```sh
+networkctl up
+networkctl down
+networkctl list
+
+# simulate the network start: print every command
+networkctl -s up
+
+# choose software to use instead of the auto-detected ones
+networkctl -n ip -d udhcpc up
+
+# start a single interface
+networkctl up eth0
+```
+
+
+# tested on
+
+* Linux: ifconfig, ip, dhclient, iw, wpa\_supplicant
+* Busybox: busybox (ifconfig, ip, udhcpc), iw, wpa\_supplicant
+* OpenBSD: ifconfig 
+
+
+# todo
+
+1. ifconfig: aliasses create a new interface, they are not put down
+2. wifi (iw, ifconfig, wpa\_supplicant...)
+3. better cli
+4. wifi reconnection on error
+5. bridge
+6. vlan
+7. network namespaces