X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=05000425e7edbeeaef7b36c7e2ebe89e29696d2e;hb=d46f501c78973312443d88fcb44b759b6a59c701;hp=0bebcc8486f441cffbcc47f857d4c324b4238f48;hpb=d3b8a135506187fe0f30f9599acae611556d777c;p=p5sagit%2FDevel-Size.git

diff --git a/README b/README
index 0bebcc8..0500042 100644
--- a/README
+++ b/README
@@ -1,10 +1,12 @@
+
+
 =pod
 
-Devel::Memory - Perl extension for finding the memory usage of Perl variables
+Devel::SizeMe - Perl extension for finding the memory usage of Perl variables
 
 =head1 SYNOPSIS
 
-  use Devel::Memory qw(size total_size);
+  use Devel::SizeMe qw(size total_size);
 
   my $size = size("A string");
   my @foo = (1, 2, 3, 4, 5);
@@ -81,14 +83,49 @@ On Windows:
 
 Please report bugs to:
 
-    http://rt.cpan.org/NoAuth/Bugs.html?Dist=Devel-Memory
+    http://rt.cpan.org/NoAuth/Bugs.html?Dist=Devel-SizeMe
 
 =head1 COPYRIGHT
 
-Copyright (C) 2005 Dan Sugalski, Copyright (C) 2007-2008 Tels,
-Copyright (C) 2011-2012 Nicholas Clark, Copyright 2012 (C) Tim Bunce.
+Copyright (C) 2005 Dan Sugalski,
+Copyright (C) 2007-2008 Tels,
+Copyright (C) 2008 BrowserUK,
+Copyright (C) 2011-2012 Nicholas Clark,
+Copyright (C) 2012 Tim Bunce.
 
 This module is free software; you can redistribute it and/or modify it
 under the same terms as Perl v5.8.8.
 
+=head1 TODO
+
+Random notes...
+
+Refactoring:
+
+    Devel::SizeMe::Core - loads XS and sets options
+    Devel::SizeMe - loads Devel::SizeMe::Core
+        -d:SizeMe=opts?
+    Devel::SizeMe::Stream - parse raw stream
+    Devel::SizeMe::Store - db write
+    Devel::SizeMe::Data - db read / orlite?
+    Devel::SizeMe::Graph - data reading/processing for sizeme_graph
+    sizeme_store - script wrapper for Devel::SizeMe::Store
+    sizeme_graph - Mojolicious app wrapper using Devel::SizeMe::Graph
+    tests!
+    Support multiple runs to same sizeme_store process, generating separate files
+    Name runs to allow total_size (for example) of multiple data structures
+
+Issues:
+
+    two cases where PERL_SUBVERSION is checked with a plain || (marked XXX)
+
+Future
+
+
+    Add addr to leaf to enable visualization of memory layout
+
+    Add token for ptr to node already seen (identified by addr I presume)
+        so we can move from a Tree to a DAG and see alternative name paths
+        and reference loops
+
 =cut