README.rdoc in net-ssh-simple-1.6.0 vs README.rdoc in net-ssh-simple-1.6.1
- old
+ new
@@ -10,24 +10,24 @@
synchronously or asynchronously.
== Features
* Friendly, flexible API for SSH and SCP (synchronous and asynchronous)
-* All results are returned as {Net::SSH::Simple::Result}[http://rubydoc.info/gems/net-ssh-simple/Net/SSH/Simple/Result]
-* All errors are raised as {Net::SSH::Simple::Error}[http://rubydoc.info/gems/net-ssh-simple/Net/SSH/Simple/Error]
+* All results are returned as {Net::SSH::Simple::Result}[http://busyloop.github.com/net-ssh-simple/doc/Net/SSH/Simple/Result]
+* All errors are raised as {Net::SSH::Simple::Error}[http://busyloop.github.com/net-ssh-simple/doc/Net/SSH/Simple/Error]
* Efficient by default; re-uses transport connections where possible
* Maintains Keep-Alive to prevent unexpected connection timeouts
* Lots of documentation
-* {100%}[https://busyloop.net/oss/net-ssh-simple/coverage/] test coverage
+* {100%}[http://busyloop.github.com/net-ssh-simple/coverage/] test coverage
== Installation
gem install net-ssh-simple
== Examples
-Note: If you are reading this on github then {click here}[http://rubydoc.info/gems/net-ssh-simple/file/README.rdoc] for a more readable
+Note: If you are reading this on github then {click here}[http://busyloop.github.com/net-ssh-simple/doc/] for a more readable
version with syntax highlighting.
=== Block Syntax (synchronous)
@@ -45,15 +45,15 @@
require 'net/ssh/simple'
t1 = Net::SSH::Simple.async do
scp_put 'example1.com', '/tmp/local_foo', '/tmp/remote_bar'
- ssh 'example3.com', 'echo "Hello World A."'
+ ssh 'example3.com', 'echo "Hello World A."'
end
t2 = Net::SSH::Simple.async do
scp_get 'example6.com', '/tmp/remote_foo', '/tmp/local_bar'
- ssh 'example7.com', 'echo "Hello World B."'
+ ssh 'example7.com', 'echo "Hello World B."'
end
r1 = t1.value # wait for t1 to finish and grab return value
r2 = t2.value # wait for t2 to finish and grab return value
puts r1.stdout #=> "Hello World A."
@@ -62,11 +62,11 @@
=== Using an instance
require 'net/ssh/simple'
s = Net::SSH::Simple.new
- s.ssh 'example1.com', 'echo "Hello World."'
+ s.ssh 'example1.com', 'echo "Hello World."'
s.scp_put 'example2.com', '/tmp/local_foo', '/tmp/remote_bar'
s.scp_get 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
s.close
== Thread safety
@@ -99,11 +99,11 @@
# to this method our ssh transport connections get re-used
# when the same remote host is accessed multiple times.
def do_something_involving_ssh
# The connections to example1-5.com are re-used across
# multiple calls to this method.
- ss.ssh 'example1.com', 'echo "Hello World."', {:user => 'not_bob'}
+ ss.ssh 'example1.com', 'echo "Hello World."', {:user => 'not_bob'}
ss.scp_put 'example2.com', '/tmp/local_foo', '/tmp/remote_bar'
ss.scp_get 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
t = ss.async do
scp_put 'example4.com', '/tmp/local_foo', '/tmp/remote_bar'
@@ -135,10 +135,10 @@
end
end
== Documentation
-See {Net::SSH::Simple}[http://rubydoc.info/gems/net-ssh-simple/Net/SSH/Simple] for more examples and full API.
+See {Net::SSH::Simple}[http://busyloop.github.com/net-ssh-simple/doc/Net/SSH/Simple] for more examples and full API.
== Running the test suite
The spec-suite makes SSH-connections to localhost, thus you need to have
your own ssh-key authorized in order to run it. Please see the comment