From ac935907b4ac2e7e1e70a4a85d2b112df59a15c1 Mon Sep 17 00:00:00 2001
From: Tom Ryder <tom@sanctum.geek.nz>
Date: Wed, 4 Oct 2017 10:43:30 +1300
Subject: Add a description of the synopsis' return value

---
 lib/List/Breakdown.pm | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

(limited to 'lib')

diff --git a/lib/List/Breakdown.pm b/lib/List/Breakdown.pm
index 44efc58..c618c76 100644
--- a/lib/List/Breakdown.pm
+++ b/lib/List/Breakdown.pm
@@ -16,7 +16,7 @@ use base qw(Exporter);
 our @EXPORT_OK = 'breakdown';
 
 # Specify package version
-our $VERSION = 0.06;
+our $VERSION = 0.07;
 
 # Dispatch table of functions to handle different ref types for the spec
 # hashref's values
@@ -89,7 +89,7 @@ List::Breakdown - Build list sublists matching conditions
 
 =head1 VERSION
 
-Version 0.06
+Version 0.07
 
 =head1 DESCRIPTION
 
@@ -120,6 +120,20 @@ You could maybe think of this as a multi-C<grep> that returns named results.
     };
     my %filtered = breakdown $cats, @words;
 
+This puts the following structure in C<%filtered>:
+
+    (
+        all    => ['foo', 'bar', 'baz', 'quux', 'wibble', 'florb'],
+        has_b  => ['bar', 'baz', 'wibble', 'florb'],
+        has_w  => ['wibble'],
+        length => {
+            3    => ['foo', 'bar', 'baz'],
+            4    => ['quux'],
+            long => ['wibble', 'florb'],
+        },
+        has_ba => ['bar', 'baz'],
+    )
+
 =head1 SUBROUTINES/METHODS
 
 =head2 B<breakdown(\%spec, @items)>
-- 
cgit v1.2.3