Update README.md

README.md

+# Ansible role - Interface - BETA (only for Ansible 2.3.3.0)
+
+This role serves for network interface configuration on debian-based systems.
+
+## Requirements
+
+* Ansible version 2.3.3.0
+
+* This role requires root access, so you either need to specify `become` directive as a global or while invoking the role.
+
+    ```yml
+    become: yes
+    ```
+    
+* Also requires Ansible variables, therefore do not disable directive `gather_facts`.
+
+## Role paramaters
+
+Mandatory parameters.
+
+* `interface_interfaces` - The list of network interface parameters. Each interface may consists of following attributes.
+    * `interface_mac` (mandatory) - .    
+    * `interface_default_gateway` (optional) - .
+    * `interface_routes` (optional) - The list of route parameters. Each route must consist of following attributes.
+        * `gateway` (mandatory) - .
+        * `network` (mandatory) - .
+        * `mask` (mandatory) - .
+
+Optional parameters.
+
+* `interface_clean` - .
+* `interface_mtu` - .
+* `interface_file_name` - .
+
+## Example
+
+Example of the simplest network interface configuration that 
+
+```yml
+roles:
+    - role: interface
+      interface_interfaces:
+          - interface_mac: 01:23:45:67:89:ab
+            interface_mtu: 1442
+```
+
+## Maintainer notes
+
+This role is primarily used for KYPO sandbox networking and due to usage
+of tool without ongoing maintenance, it is necessary that this role supports
+at most Ansible version 2.3.3.0. This version contains some bugs and limitations
+and therefore this role has to take as argument list of interface configurations
+instead of configuration for single interface.