Update 'Home'

Home.md

@@ -0,0 +1,18 @@
+Welcome to the Wiki for pyscaniptonetbox.
+
+This is a simplistic script which scans an IPV4 network (using ping via python networkscan library) and then adds each IP address to a Netbox server that is configured in local_settings.yaml
+
+local_settings.yaml will require the netbox server url and an api Key.
+For this reason - local_settings.yaml is configured in .gitignore
+
+There is a sample in examples/local_settings_SAMPLE.yaml 
+
+
+The script takes as the first argument, the name of the 'tenant' configured in Netbox to determine what IP prefixes are assigned.
+The second argument is the IP subnet to scan in CIDR notation e.g 192.168.1.0/24 
+
+An actual update will only be performed if the word 'update' is typed at the relevant prompt.
+(todo - add extra flags to allow non-interactive use)
+
+
+