more documentation

Changes

@@ -6,6 +6,7 @@ Revision history for CPAN-Testers-WWW-Reports-Query-AJAX
         - added documentation about the CPAN Testers Fund.
         - extended META testing.
         - fixed option validation.
+        - more documentation.
 
 0.08    2014-04-04
         - refine percentage calculation to 10 decimal places.

lib/CPAN/Testers/WWW/Reports/Query/AJAX.pm

@@ -238,6 +238,63 @@ Instatiates the object CPAN::WWW::Testers. Requires a hash of parameters, with
 'config' being the only mandatory key. Note that 'config' can be anything that
 L<Config::IniFiles> accepts for the I<-file> option.
 
+Available parameters are
+
+=over 4
+
+item * dist (required)
+
+The distribution to provide a summary for. An error will be returned if no
+distribution name is provided.
+
+item * version (optional)
+
+Filter based on a specific distribution version. Defaults to the latest 
+version.
+
+item * perlmat (optional)
+
+Filter based on perl maturity, i.e. whether a development version (5.21.3) or
+a stable version (5.20.1). Values are:
+
+=over 4
+
+=item * 0 = all reports
+=item * 1 = stable versions only
+=item * 2 = development versions only
+
+=back
+
+item * patches (optional)
+
+Filter based on whether the perl version is a patch. Values are:
+
+=over 4
+
+=item * 0 = all reports
+=item * 1 = patches only
+=item * 2 = exclude patches
+
+=back
+
+Defaults to all reports.
+
+item * perlver (optional)
+
+Filter based on Perl version, e.g. 5.20.1. Defaults to all versions.
+
+item * osname (optional)
+
+Filter based on Operating System name, e.g. MSWin32. Defaults to all Operating 
+Systems.
+
+item * format (optional)
+
+Available formats are: 'csv', 'txt', 'html' and 'xml'. Defaults to 'html'.
+'txt' is provided for backwards compatibility, but is mapped to 'csv'.
+
+=back
+
 =back
 
 =head2 Status Methods