More documentation

1 files changed, 56 insertions, 1 deletions

diff --git a/lib/Travel/Status/DE/VRR.pm b/lib/Travel/Status/DE/VRR.pm
index 2a38eae..cbb1262 100644
--- a/lib/Travel/Status/DE/VRR.pm
+++ b/lib/Travel/Status/DE/VRR.pm
@@ -121,30 +121,85 @@ Travel::Status::DE::VRR - inofficial VRR departure monitor
 
 =head1 SYNOPSIS
 
+    use Travel::Status::DE::VRR;
+
+    my $status = Travel::Status::DE::VRR->new(
+        place => 'Essen', name => 'Helenenstr'
+    );
+
+    for my $d ($status->results) {
+        printf(
+            "%s %-8s %-5s %s\n",
+            $d->time, $d->platform, $d->line, $d->destination
+        );
+    }
+
 =head1 VERSION
 
-version
+version 0.00
 
 =head1 DESCRIPTION
 
+Travel::Status::DE::VRR is an inofficial interface to the VRR departure
+monitor available at
+L<http://efa.vrr.de/vrr/XSLT_DM_REQUEST?language=de&itdLPxx_transpCompany=vrr&>.
+
+It shows all upcoming tram/bus/train departures at a given stop.
+
 =head1 METHODS
 
 =over
 
+=item my $status = Travel::Status::DE::VRR->new(I<%opt>)
+
+Returns a new Travel::Status::DE::VRR object. Dies if the request failed.
+
+Arguments:
+
+=over
+
+=item B<place> => I<place>
+
+Name of the place/city
+
+=item B<name> => I<stop name>
+
+Name of the stop to list departures for.  In future versions, this may also
+support street or poi ("point of interest") names
+
+=back
+
+=item $status->results
+
+Returns a list of Travel::Status::DE::VRR::Result(3pm) objects, each one describing
+one departure.
+
 =back
 
 =head1 DIAGNOSTICS
 
+None.
+
 =head1 DEPENDENCIES
 
 =over
 
+=item * Class::Accessor(3pm)
+
+=item * WWW::Mechanize(3pm)
+
+=item * XML::LibXML(3pm)
+
 =back
 
 =head1 BUGS AND LIMITATIONS
 
+Not all features of the web interface are supported.
+
 =head1 SEE ALSO
 
+efa-m(1), Travel::Status::DE::VRR::Result(3pm).
+
 =head1 AUTHOR
 
 Copyright (C) 2011 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>