[Checkins] SVN: zc.buildoutsftp/branches/dev/ Updated release info.

[Jim Fulton]

Log message for revision 70174:
  Updated release info.
  

Changed:
  U   zc.buildoutsftp/branches/dev/README.txt
  U   zc.buildoutsftp/branches/dev/setup.py

-=-
Modified: zc.buildoutsftp/branches/dev/README.txt
===================================================================
--- zc.buildoutsftp/branches/dev/README.txt	2006-09-14 12:34:21 UTC (rev 70173)
+++ zc.buildoutsftp/branches/dev/README.txt	2006-09-14 15:00:05 UTC (rev 70174)
@@ -12,26 +12,31 @@
 
 An SFTP URL is similar to an FTP URL and is of the form::
 
-  sftp:://user:password at hostname:port/path
+  sftp://user:password@hostname:port/path
 
 where the user name, password, and port are optional.  Here are some
 examples:
 
-sftp://download.zope.org/distribution
-   This accesses the path /distribution on download.zope.org
+The following URL accesses the path /distribution on download.zope.org::
 
-sftp://jim@download.zope.org/distribution
-   This accesses the path /distribution on download.zope.org using the
-   user id jim.
+  sftp://download.zope.org/distribution
 
-sftp://jim:123@download.zope.org/distribution
-   This accesses the path /distribution on download.zope.org using the
-   user id jim and password 123.
+The following URL accesses the path /distribution on download.zope.org
+using the user id jim::
 
-sftp://download.zope.org:1022/distribution
-   This accesses the path /distribution on download.zope.org using an
-   ssh server running on port 1022.
+   sftp://jim@download.zope.org/distribution
 
+The following URL accesses the path /distribution on download.zope.org
+using the user id jim and password 123::
+
+  sftp://jim:123@download.zope.org/distribution
+
+
+The following url accesses the path /distribution on download.zope.org
+using an ssh server running on port 1022::
+
+  sftp://download.zope.org:1022/distribution
+
 The buildout extension actually installs a urllib2 handler for the
 "sftp" protocol.  This handler is actually setuptools specific because
 it generates HTML directory listings, needed by setuptools and makes
@@ -40,3 +45,9 @@
 extension mechanism for handling alternate protocols, in which case,
 we might bypass the urllib2 extension mechanism.
 
+SSH Compatibility
+=================
+
+The extension works with Open SSH on unix-based systems and PuTTY on
+Windows.  Unless a password is given in the URL, private keys are
+ontained from ssh agent (pagent on Windows).

Modified: zc.buildoutsftp/branches/dev/setup.py
===================================================================
--- zc.buildoutsftp/branches/dev/setup.py	2006-09-14 12:34:21 UTC (rev 70173)
+++ zc.buildoutsftp/branches/dev/setup.py	2006-09-14 15:00:05 UTC (rev 70174)
@@ -10,7 +10,7 @@
     "Specialized zc.buildout plugin to add sftp support.",
     long_description = (
         open('README.txt').read()
-        +
+        + '\n' + 
         open('CHANGES.txt').read()
         ),
     license = "ZPL 2.1",