fix up dist generation
[scpubgit/Tak.git] / lib / Tak.pm
index dfa1930..92cc7dd 100644 (file)
@@ -3,6 +3,8 @@ package Tak;
 use Tak::Loop;
 use strictures 1;
 
+our $VERSION = '0.001001'; # 0.1.1
+
 our $loop;
 
 sub loop { $loop ||= Tak::Loop->new }
@@ -35,4 +37,61 @@ sub await_all {
   return;
 }
 
-1;
+"for lexie";
+
+=head1 NAME
+
+Tak - Multi host remote control over ssh
+
+=head1 SYNOPSIS
+
+  bin/tak -h user1@host1 -h user2@host2 exec cat /etc/hostname
+
+or
+
+  in Takfile:
+
+  package Tak::MyScript;
+  
+  use Tak::Takfile;
+  use Tak::ObjectClient;
+  
+  sub each_get_homedir {
+    my ($self, $remote) = @_;
+    my $oc = Tak::ObjectClient->new(remote => $remote);
+    my $home = $oc->new_object('Path::Class::Dir')->absolute->stringify;
+    $self->stdout->print(
+      $remote->host.': '.$home."\n"
+    );
+  }
+  
+  1;
+
+then
+
+  tak -h something get-homedir
+
+=head1 WHERE'S THE REST?
+
+A drink leaked in my bag on the way back from LPW. You'll get more once I
+get my laptop's drive into an enclosure and decant the slides.
+
+=head1 AUTHOR
+
+mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
+
+=head1 CONTRIBUTORS
+
+None required yet. Maybe this module is perfect (hahahahaha ...).
+
+=head1 COPYRIGHT
+
+Copyright (c) 2011 the strictures L</AUTHOR> and L</CONTRIBUTORS>
+as listed above.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut