Add SYNOPSIS sections for Zeal::Document and ::Docset

diff --git a/lib/Zeal/Docset.pm b/lib/Zeal/Docset.pm
index 3a54621a2cade5ea3c9be240f58116e8a4fa1355..88c52e284b2f5d09e764cf518a2bdca05d06a7d3 100644 (file)
--- a/lib/Zeal/Docset.pm
+++ b/lib/Zeal/Docset.pm
@@ -83,6 +83,17 @@ Zeal::Docset - Class representing a Dash/Zeal docset
 =head1 SYNOPSIS
 
   use Zeal::Docset;
+  my $ds = Zeal::Docset->new('/home/mgv/docsets/Perl.docset');
+  say $ds->$path;  # /home/mgv/docsets/Perl.docset
+  say $ds->name;   # Perl
+  say $ds->id;     # perl
+  say $ds->family; # perl
+
+  # In SQL LIKE, % is .* and _ is .
+  my @matches = $ds->query('perlopen%'); # finds perlopenbsd and perlopentut
+  my $doc = $ds->query('perlsec'); # A Zeal::Document object for perlsec
+  my $html = $ds->get('perls_c'); # HTML documentation of perlsec
+  my @docs = $ds->list; # all documents
 
 =head1 DESCRIPTION
 

diff --git a/lib/Zeal/Document.pm b/lib/Zeal/Document.pm
index f80bad8d35f5868d91050bc3a37d9f8485d8cf26..88125027bc1c56f98752275788235113e498e1a4 100644 (file)
--- a/lib/Zeal/Document.pm
+++ b/lib/Zeal/Document.pm
@@ -26,6 +26,11 @@ Zeal::Document - Class representing a Dash/Zeal document
 =head1 SYNOPSIS
 
   use Zeal::Document;
+  my $doc = $ds->query('perlsec'); # $ds is a Zeal::Docset instance
+  say $doc->name; # perlsec
+  say $doc->type; # Module
+  say $doc->path; # perldoc-html/perlsec.html
+  my $html = $doc->fetch; # $html is now the HTML documentation for perlsec
 
 =head1 DESCRIPTION