aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2009-10-13 22:23:06 +0200
committerAndreas Schneider <mail@cynapses.org>2009-10-13 22:23:06 +0200
commitc360ed1d9ad4ee0a65dd80494605c55802c30ba3 (patch)
tree17069a2d662baf7f0a56fa269652a90891577099 /README
parent22e74e3bab259ed8b6a89cef1fe85f2e99c530b8 (diff)
downloadlibssh-c360ed1d9ad4ee0a65dd80494605c55802c30ba3.tar.gz
libssh-c360ed1d9ad4ee0a65dd80494605c55802c30ba3.tar.xz
libssh-c360ed1d9ad4ee0a65dd80494605c55802c30ba3.zip
Add API changes to README.
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 21 insertions, 1 deletions
diff --git a/README b/README
index 7140605..b01bdd6 100644
--- a/README
+++ b/README
@@ -1,7 +1,6 @@
libssh: the SSH library
~~~~~~~~~~~~~~~~~~~~~~~
-
1* Why ?
-_-_-_-_-_
@@ -26,3 +25,24 @@ If you ask yourself how to compile libssh, please read INSTALL before anything.
-_-_-_-_-_-_
http://www.libssh.org
+
+4* API Changes !
+-_-_-_-_-_-_-_-_-_
+
+Changes between 0.3 and 0.4
+---------------------------
+
+We changed libssh to be typesafe now:
+
+SSH_SESSION *session -> ssh_session session
+SFTP_SESSION *sftp -> sftp_session sftp
+CHANNEL *channel -> ssh_channel channel
+STRING *string -> ssh_string string
+...
+
+The options structure has been removed and there is a new function. This
+function can set all available options now. You can find the enum in the
+header file and it is documented. Example:
+
+ssh_options_set(session, SSH_OPTIONS_HOST, "localhost");
+