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

[zeal.git] / lib / Zeal / Document.pm

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