Update namespace docs

Author: hugoduncan

project.clj

@@ -1,5 +1,6 @@
 (defproject clj-ssh "0.4.0-SNAPSHOT"
   :description "Library for using SSH from clojure."
+  :url "https://github.com/hugoduncan/clj-ssh"
   :dependencies [[org.clojure/clojure "1.2.1"]
                  [org.clojure/tools.logging "0.1.2"]
                  [jsch-agent-proxy "0.0.4"]
@@ -23,4 +24,7 @@
                                 [org.clojure/clojure "1.4.0-beta1"]]}
   :codox {:writer codox-md.writer/write-docs
           :version "0.4"
-          :output-dir "doc/api/0.4"})
+          :output-dir "doc/api/0.4"
+          :exclude [clj-ssh.agent clj-ssh.reflect clj-ssh.keychain]}
+  :license {:name "Eclipse Public License"
+            :url "http://www.eclipse.org/legal/epl-v10.html"})

src/clj_ssh/cli.clj

@@ -1,5 +1,27 @@
 (ns clj-ssh.cli
-  "Provides a REPL friendly interface for clj-ssh."
+  "Provides a REPL friendly interface for clj-ssh.
+
+There is a simple `ssh` function, which by default, will use the system
+ssh-agent.
+
+    (ssh \"hostname\" \"ls\")
+
+Strict host key checking can be turned off.
+
+    (default-session-options {:strict-host-key-checking :no})
+
+By default, your current username is used.  If your key has a passphrase, and
+you are on OSX, then you should be asked for access to your keychain.  If you
+are on any other OS without a ssh-agent, you will need to explicitly add your
+key to the clj-ssh's ssh-agent with the appropriate add-identity call.
+
+SFTP is supported:
+
+    (sftp \"hostname\" :put \"/from/this/path\" \"to/this/path\")
+
+Note that any sftp commands that change the state of the sftp session (such as
+cd) do not work with the simplified interface, as a new session is created each
+time."
   (:require
    [clj-ssh.ssh :as ssh]
    [clojure.string :as string]))
@@ -156,8 +178,7 @@ Options are
 :password   password to use for authentication
 :port       port to use if no session specified
 :with-monitor
-:modes
-"
+:modes"
   [hostname cmd & args]
   (let [{:keys [ssh-agent args]
          :or {ssh-agent *ssh-agent*}

src/clj_ssh/ssh.clj

@@ -1,31 +1,27 @@
 (ns ^{:author "Hugo Duncan"}
   clj-ssh.ssh
-  "SSH in clojure.  Uses jsch.  Provides a ssh function that tries to look
-similar to clojure.contrib.shell/sh.
+  "API for using SSH in clojure.
 
 ## Usage
 
-The top level namespace is `clj-ssh.ssh`
-
     (use 'clj-ssh.ssh)
 
-    (with-ssh-agent (ssh-agent {})
-      (add-identity {:private-key-path path-to-private-key})
-      (let [session (session hostname :strict-host-key-checking :no)]
+    (let [agent (ssh-agent {})]
+      (add-identity agent {:private-key-path path-to-private-key})
+      (let [session (session agent hostname :strict-host-key-checking :no)]
         (with-connection session
-          (let [result (ssh session :in commands-string :result-map true)]
-            (println (result :out)))
-          (let [result (ssh session some-cmd-string)]
-            (println (second result))))))
-
-## Installation
-
-Via maven and the clojars (http://clojars.org/clj-ssh), or
-Leiningen (http://github.com/technomancy/leiningen).
+          (let [result (ssh session {:in commands-string})]
+            (println (:out result)))
+          (let [result (ssh session {:cmd some-cmd-string})]
+            (println (:out result))))))
 
-## License
-
-Licensed under EPL (http://www.eclipse.org/legal/epl-v10.html)"
+    (let [agent (ssh-agent {})]
+      (let [session (session agent \"localhost\" {:strict-host-key-checking :no})]
+        (with-connection session
+          (let [channel (ssh-sftp session)]
+            (with-channel-connection channel
+              (sftp channel :cd \"/remote/path\")
+              (sftp channel :put \"/some/file\" \"filename\"))))))"
   (:require
    [clj-ssh.agent :as agent]
    [clj-ssh.keychain :as keychain]