further detail OR->connect arguments, and document other bits

[scpubgit/Object-Remote.git] / lib / Object / Remote / Connector / STDIO.pm

diff --git a/lib/Object/Remote/Connector/STDIO.pm b/lib/Object/Remote/Connector/STDIO.pm
index 69ba95d..781ed9d 100644 (file)
--- a/lib/Object/Remote/Connector/STDIO.pm
+++ b/lib/Object/Remote/Connector/STDIO.pm
@@ -24,3 +24,20 @@ sub connect {
 }
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connector::STDIO - A connector used in remote OR nodes
+
+=head1 DESCRIPTION
+
+This connector only exists to provide L<Object:Remote::Node> with a connection
+that handles its OR JSON command and response processing. Reads from STDIN and
+prints to STDOUT.
+
+=head1 ARGUMENTS
+
+Provides no arguments. However the adventurous can replace STDIN/STDOUT of the
+current process with other filehandles.
+
+=cut