dont ignore example

.gitignore

@@ -1 +1,3 @@
-scans/
+scans/*.yaml
+!scans/example.yaml
+scans/*.xml

README.md

@@ -0,0 +1,8 @@
+# lanScan
+
+Scan hosts with nmap and display results in webpage.
+
+* Create a configuration yaml file in scans/ subdirectory (see example.yaml).
+It make be generated by scanning a network with init.sh.
+* Scan with scan_all.sh (use a cron task!).
+* Open index.php to see results.

scans/example.yaml

@@ -0,0 +1,5 @@
+group1:
+  host1.local: [ssh, http]
+  host2.local: [ftp, https, 5432]
+group2:
+  host3: [ssh, ftp, 8006]