Create README.md

dtylman · Aug 25, 2016 · 1a4f113 · 1a4f113
1 parent fe9b5e9
commit 1a4f113
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,26 @@
+## SCP Example
+
+### Compile 
+```
+go build
+```
+
+### Running
+`example` will use `scp` to copy a remote file locally. Local files created on the working folder with the remote base name.
+
+Usage: host:port username remotepath
+
+#### Notes
+
+Port must be set!
+
+Password will be prompted for.
+
+
+```
+localhost$ ./example naboo.local:22 root /var/log/lastlog
+Password: ********
+Opening tcp to naboo.local:22
+Establishing ssh session naboo.local:22...
+Copied 292584 bytes in 327.874073ms
+```