start on some docs

1 files changed, 17 insertions, 0 deletions

diff --git a/lib/Reply/Plugin/ResultCache.pm b/lib/Reply/Plugin/ResultCache.pm
index fc260f5..a973d05 100644
--- a/lib/Reply/Plugin/ResultCache.pm
+++ b/lib/Reply/Plugin/ResultCache.pm
@@ -1,9 +1,26 @@
 package Reply::Plugin::ResultCache;
 use strict;
 use warnings;
+# ABSTRACT: retain previous results to be able to refer to them later
 
 use base 'Reply::Plugin';
 
+=head1 SYNOPSIS
+
+  ; .replyrc
+  [ResultCache]
+  variable = r
+
+=head1 DESCRIPTION
+
+This plugin caches the results of successful evaluations, and provides them in
+a lexical array (by default C<@res>, although this can be changed via the
+C<variable> option). This means that you can, for instance, access the value
+returned by the previous line with C<$res[-1]>. It also modifies the output to
+include an indication of where the value is stored, for later reference.
+
+=cut
+
 sub new {
     my $class = shift;
     my %opts = @_;