jsoninfo: updated README with description of what this plugin is for
authorHans-Christoph Steiner <hans@eds.org>
Tue, 26 Jun 2012 17:51:26 +0000 (13:51 -0400)
committerHans-Christoph Steiner <hans@eds.org>
Tue, 26 Jun 2012 17:51:37 +0000 (13:51 -0400)
lib/jsoninfo/README_JSONINFO

index 32b31aa..baa44d5 100644 (file)
@@ -1,11 +1,22 @@
 
-   PLUGIN USAGE
-==================
+The jsoninfo plugin aims to deliver all of the information about the
+runtime status and configuration of olsrd.  You can request specific
+chunks of information, or overviews of runtime or startup
+configuration, or all of the information in one report. Additionally,
+the jsoninfo plugin will dump the current olsrd config in the
+olsrd.conf format.  The jsoninfo plugin provides all of the
+information that both the txtinfo and httpinfo plugins provide, as
+well as quite a bit more.
 
-installation:
-make
-make install
+There is a Java library called OlsrInfo that provides Java classes for
+parsing the data from jsoninfo (and txtinfo also).  It is based on the
+Jackson JSON processing library
 
+OlsrInfo: https://github.com/guardianproject/OlsrInfo
+Jackson JSON: http://jackson.codehaus.org/
+
+PLUGIN USAGE
+============
 
 There are a number of commands for getting information from this
 plugin.  They are designed to be tacked onto a URL, but can also be
@@ -40,8 +51,8 @@ start-up information not in JSON format:
 * /olsrd.conf - the current config, formatted for writing directly to /etc/olsrd.conf
 
 
-   PLUGIN CONFIGURATION
-==========================
+PLUGIN CONFIGURATION
+====================
 
 The plugin accepts two parameters: "port" and "accept". There are no
 futher parameters.  Here's an example configuration for UNIX systems