added node.d/README.md

diff --git a/conf.d/Makefile.am b/conf.d/Makefile.am
index 7806818e3baefddaeffd1389a22d7ee865c389d4..4b24ac050d717b81cc237acdb2291b75c8671876 100644 (file)
--- a/conf.d/Makefile.am
+++ b/conf.d/Makefile.am
@@ -18,6 +18,7 @@ dist_chartsconfig_DATA = \
 
 nodeconfigdir=$(configdir)/node.d
 dist_nodeconfig_DATA = \
+       node.d/README.md \
        node.d/named.conf.md \
        node.d/sma_webbox.conf.md \
        node.d/snmp.conf.md \

diff --git a/conf.d/node.d/README.md b/conf.d/node.d/README.md
new file mode 100644 (file)
index 0000000..45e3d02
--- /dev/null
+++ b/conf.d/node.d/README.md
@@ -0,0 +1,7 @@
+`node.d.plugin` modules accept configuration in JSON format.
+
+Unfortunately, JSON files do not accept comments. So, the best way to describe them is to have markdown text files with instructions.
+
+JSON has a very strict formatting. If you get errors from netdata at `/var/log/netdata/error.log` that a certain configuration file cannot be loaded, we suggest to verify it at [http://jsonlint.com/](http://jsonlint.com/).
+
+The files in this directory, provide usable examples for configuring each `node.d.plugin` module.