Add more documentation bits

[scpubgit/System-Introspector.git] / lib / System / Introspector.pm

diff --git a/lib/System/Introspector.pm b/lib/System/Introspector.pm
index e439a91..2bf4ec8 100644 (file)
--- a/lib/System/Introspector.pm
+++ b/lib/System/Introspector.pm
@@ -6,3 +6,43 @@ our $VERSION = '0.000001';
 $VERSION = eval $VERSION;
 
 1;
+
+=head1 NAME
+
+System::Introspector - framework for remote system introspection
+
+=head1 SYNOPSIS
+
+  $ system-introspector --storage <path> --config <path> [OPTIONS]
+
+See L<system-introspector(1)> for detailed information about which OPTIONS
+can be used.
+
+=head1 DESCRIPTION
+
+System::Introspector is a framework for remotely executing system wide
+introspection. The introspection is done executing a set of probes
+on the remote system that gather specific information. Gathered results
+are stored in JSON format.
+
+=head1 CONTRIBUTORS
+
+phaylon - Robert Sedlacek (cpan:PHAYLON) <rs@474.at>
+
+=head1 AUTHOR
+
+mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
+
+=head1 SPONSORED
+
+Lots of this stuff sponsored by L<http://socialflow.com>.
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the System::Introspector L</AUTHOR> and L</CONTRIBUTORS>
+as listed above.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.