Update README and FAQ

Author: dgarros

FAQ.md

@@ -1,8 +1,6 @@
-
-
 # Frequenty Asked Questions
 
-### Is it possible to disable the automatic creation of Device Type or Device Role ?
+### Is it possible to disable the automatic creation of Device Type, Device Role or Platform ?
 
 > **Yes**, Using the plugin settings, it's possible to control individually the creation of `device_role`, `device_type`, `manufacturer` & `platform`
 
@@ -20,24 +18,28 @@
 # }
 ```
 
-### Does this plugin support the discovery and the creation of Interfaces and IP Address
+### Does this plugin support the discovery and the creation of all interfaces and IP Addresses ?
+
+> **No**, The plugin will only discover and create the management interface and the management IP address. Importing all interfaces and IP addresses is a much larger problem that requires more preparation. This is out of scope of this project.
+
+### Does this plugin support the discovery of device based on fqdn ? 
 
-> **No**, this plugin will only discover and create the management interface and the management IP address. Importing all interfaces and IP addresses is a much larger problem that requires more preparation. This is out of scope of this project.
+> **No**, Current the onbarding process is based on an IP address, please open an issue to discuss your use case if you would like to see support for FQDN based devices too. 
 
-### Does this plugin support the discovery of Stack or Virtual Chassis devices
+### Does this plugin support the discovery of Stack or Virtual Chassis devices ?
 
-> **Partially**, Multi member devices (Stack, Virtual Chassis, FW Pair) can be imported but they will be seen as a single device. 
+> **Partially**, Multi member devices (Stack, Virtual Chassis, FW Pair) can be imported but they will be created as a single device. 
 
-### Is this plugin able to automatically discover the type of my device
+### Is this plugin able to automatically discover the type of my device ? 
 
-> **Yes**, This plugin is leveraging Netmiko & Napalm to attempt to automatically discover the type of OS of each device.
+> **Yes**, The plugin is leveraging Netmiko & Napalm to attempt to automatically discover the OS and the model of each device.
 
-### How many device can I import at the same time
+### How many device can I import at the same time ?
 
 > **Many**, There is really not strict limitations regarding the number of devices that can be importer at the same time. The speed at which devices will be imported will depend of the number of active RQ workers.
 
 ### Do I need to setup a dedicated RQ Worker node ?
 
-> **No**, The plugin is leveraging the existing RQ Worker infrastructure already in place in NetBox, the only requirements is to ensure the plugin it self is installed in the Worker node itself.
+> **No**, The plugin is leveraging the existing RQ Worker infrastructure already in place in NetBox, the only requirement is to ensure the plugin itself is installed in the Worker node.
 
 

README.md

@@ -5,7 +5,7 @@
 
 A plugin for [NetBox](https://github.com/netbox-community/netbox) to easily onboard new devices.
 
-`ntc-netbox-plugin-onboarding` is leverating Netmiko, NAPALM & Django-RQ to simplify the onboarding process of a new device into NetBox down to an IP Address and a site.
+`ntc-netbox-plugin-onboarding` is leverating [Netmiko](https://github.com/ktbyers/netmiko), [NAPALM](https://napalm.readthedocs.io/en/latest/) & [Django-RQ](https://github.com/rq/django-rq) to simplify the onboarding process of a new device into NetBox down to an IP Address and a site.
 The goal of this plugin is not to import everything about a device into NetBox but rather to help build quickly an inventory in NetBox that is often the first step into an automation journey.
 
 ## Installation
@@ -20,18 +20,21 @@ Once installed, the plugin need to be enabled in your `configuration.py`
 # In your configuration.py
 PLUGINS = ["netbox_onboarding"]
 
-# If need you can override the default settings of the plugin too
 # PLUGINS_CONFIG = {
 #   "netbox_onboarding": {
-#         "create_platform_if_missing": True,
-#         "create_manufacturer_if_missing": True,
-#         "create_device_type_if_missing": True,
-#         "create_device_role_if_missing": True,
-#         "default_device_role": "network",
+#     ADD YOUR SETTINGS HERE
 #   }
 # }
 ```
 
+The plugin behavior can be controlled with the following list of settings
+
+- `create_platform_if_missing` boolean (default True), If True, a new platform object will be created if the platform discovered by netmiko do not already exist and is in the list of supported platforms (`cisco_ios`, `cisco_nxos`, `arista_eos`, `juniper_junos`, `cisco_xr`)
+- `create_device_type_if_missing` boolean (default True), If True, a new device type object will be created if the model discovered by Napalm do not match an existing device type.
+- `create_manufacturer_if_missing` boolean (default True), If True, a new manufacturer object will be created if the manufacturer discovered by Napalm is do not match an existing manufacturer, this option is only valid if `create_device_type_if_missing` is True as well.
+- `create_device_role_if_missing` boolean (default True), If True, a new device role object will be created if the device role provided was not provided as part of the onboarding and if the `default_device_role` do not already exist. 
+- `default_device_role` string  (default "network")
+
 ## Usage
 ### Preparation
 
@@ -48,6 +51,8 @@ A new device can be onboarded via :
 - A CSV form to import multiple devices in bulk. `/plugins/onboarding/import/`
 - An API, `POST /plugins​/onboarding​/onboarding​/`
 
+During a successful onboarding process, a new device will be created in NetBox with its management interface and its primary IP assigned. The management interface will be discovered on the device based on the IP address provided.
+
 ### Consult the status of onboarding tasks
 
 The status of the onboarding process for each device is maintain is a dedicated table in NetBox and can be retrive :
@@ -58,7 +63,7 @@ The status of the onboarding process for each device is maintain is a dedicated
 
 ### API
 
-The plugin comes with 4 new API endpoints to manage devices onbarding tasks
+The plugin includes 4 API endpoints to manage the onbarding tasks
 
 ```shell
 GET        /plugins​/onboarding​/onboarding​/       Check status of all onboarding tasks.
@@ -71,18 +76,17 @@ DELETE    ​ /plugins​/onboarding​/onboarding​/{id}​/  Delete a specifi
 
 Pull requests are welcomed and automatically built and tested against multiple version of Python and multiple version of NetBox through TravisCI.
 
-The project is packaged with a light development environment based on docker-compose to help with the local development of the project and to run the tests within TravisCI.
+The project is packaged with a light development environment based on `docker-compose` to help with the local development of the project and to run the tests within TravisCI.
 
 The project is following Network to Code software development guideline and is leveraging:
-- Black, Pylint, Bandit and pydocstyle for Python format
+- Black, Pylint, Bandit and pydocstyle for Python linting and formatting.
 - Django unit test to ensure the plugin is working properly.
 
 ### CLI Helper Commands
 
-The project is coming with a CLI helper based on `invoke` to help setup the development environment. The commands are listed below in 3 categories `dev environment`, `utility` and `testing`. 
+The project is coming with a CLI helper based on [invoke](http://www.pyinvoke.org/) to help setup the development environment. The commands are listed below in 3 categories `dev environment`, `utility` and `testing`. 
 
-Each command can be executed with `invoke <command>`
-All commands support the arguments `--netbox-ver` and `--python-ver` if you want to manually the version of Python and NetBox to use. Each command also has its own help `invoke <command> --help`
+Each command can be executed with `invoke <command>`. All commands support the arguments `--netbox-ver` and `--python-ver` if you want to manually define the version of Python and NetBox to use. Each command also has its own help `invoke <command> --help`
 
 #### Local dev environment
 ```