added example on Tak Use

[scpubgit/Tak.git] / lib / Tak.pm

diff --git a/lib/Tak.pm b/lib/Tak.pm
index 65a6153..7258b73 100644 (file)
--- a/lib/Tak.pm
+++ b/lib/Tak.pm
@@ -3,7 +3,7 @@ package Tak;
 use Tak::Loop;
 use strictures 1;
 
-our $VERSION = '0.001001'; # 0.1.1
+our $VERSION = '0.001003'; # 0.1.3
 
 our ($loop, $did_upgrade);
 
@@ -45,7 +45,7 @@ sub await_all {
   return;
 }
 
-"for lexie";
+1;
 
 =head1 NAME
 
@@ -81,8 +81,46 @@ then
 
 =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.
+A drink leaked in my bag on the way back from LPW. My laptop is finally
+alive again though so I'll try and turn my slides into a vague attempt
+at documentation while I'm traveling to/from christmas things.
+
+=head1 Example
+
+$ cat Takfile
+package Tak::MyScript;
+
+use strict;
+use warnings;
+
+use Tak::Takfile;
+use Tak::ObjectClient;
+use lib "./lib";
+
+sub each_host {
+    my ($self, $remote) = @_;
+
+    my $oc = Tak::ObjectClient->new(remote => $remote);
+    my $name = $oc->new_object('My::Hostname');
+    print "Connected to hostname: " . $name . "\n";
+    }
+
+1;
+
+-----
+
+$cat ./lib/My/Hostname
+package My::Hostname;
+
+use Sys::Hostname;
+
+sub new {
+    my ($self) = @_;
+    my $name = hostname;
+    return $name;
+    }
+
+1;
 
 =head1 AUTHOR
 
@@ -94,7 +132,7 @@ None required yet. Maybe this module is perfect (hahahahaha ...).
 
 =head1 COPYRIGHT
 
-Copyright (c) 2011 the strictures L</AUTHOR> and L</CONTRIBUTORS>
+Copyright (c) 2011 the Tak L</AUTHOR> and L</CONTRIBUTORS>
 as listed above.
 
 =head1 LICENSE