Releasing 1.1pre1.

[tinc] / README

diff --git a/README b/README
index 23b2458..77057b0 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
-This is the README file for tinc version 1.0.9. Installation
+This is the README file for tinc version 1.1pre1. Installation

 instructions may be found in the INSTALL file.
 
 instructions may be found in the INSTALL file.
 

-tinc is Copyright (C) 1998-2008 by:
+tinc is Copyright (C) 1998-2011 by:

 
 Ivo Timmermans,
 Guus Sliepen <guus@tinc-vpn.org>,
 
 Ivo Timmermans,
 Guus Sliepen <guus@tinc-vpn.org>,


@@ -15,6 +15,17 @@ the Free Software Foundation; either version 2 of the License, or (at
 your option) any later version. See the file COPYING for more details.
 
 
 your option) any later version. See the file COPYING for more details.
 
 

+This is a pre-release
+---------------------
+
+Please note that this is NOT a stable release. Until version 1.1.0 is released,
+please use one of the 1.0.x versions if you need a stable version of tinc.
+
+Although tinc 1.1 will be protocol compatible with tinc 1.0.x, the
+functionality of the tincctl program may still change, and the control socket
+protocol is not fixed yet.
+
+

 Security statement
 ------------------
 
 Security statement
 ------------------
 


@@ -45,40 +56,30 @@ prove the security of any cryptographic product. If you wish to review
 tinc or give us feedback, you are stronly encouraged to do so.
 
 
 tinc or give us feedback, you are stronly encouraged to do so.
 
 

-Changes to configuration file format since 1.0pre5
---------------------------------------------------
-
-Some configuration variables have different names now. Most notably "TapDevice"
-should be changed into "Device", and "Device" should be changed into
-"BindToDevice".
-

 Compatibility
 -------------
 
 Compatibility
 -------------
 

-Version 1.0.9 is compatible with 1.0pre8, 1.0 and later, but not with older
+Version 1.1pre1 is compatible with 1.0pre8, 1.0 and later, but not with older

 versions of tinc.
 
 
 Requirements
 ------------
 
 versions of tinc.
 
 
 Requirements
 ------------
 

-Since 1.0pre3, we use OpenSSL for all cryptographic functions.  So you
-need to install this library first; grab it from
-http://www.openssl.org/.  You will need version 0.9.7 or later.  If
-this library is not installed on you system, configure will fail.  The
-manual in doc/tinc.texi contains more detailed information on how to
-install this library.
+Either OpenSSL (http://www.openssl.org/) or libgcrypt
+(http://www.gnupg.org/download/#libgcrypt).

 
 

-Since 1.0pre6, the zlib library is used for optional compression. You need this
-library whether or not you plan to enable the compression. You can find it at
-http://www.gzip.org/zlib/. Because of a possible exploit in earlier versions we
-recommand that you download version 1.1.4 or later.
+The zlib library is used for optional compression. You can find it at
+http://www.gzip.org/zlib/.

 
 

-Since 1.0, the lzo library is also used for optional compression. You need this
-library whether or not you plan to enable compression. You can find it at
+The lzo library is also used for optional compression. You can find it at

 http://www.oberhumer.com/opensource/lzo/.
 
 http://www.oberhumer.com/opensource/lzo/.
 

-In order to compile tinc, you will need a GNU C compiler environment.
+Since 1.1, the libevent library is used for the main event loop. You can find
+it at http://monkey.org/~provos/libevent/.
+
+In order to compile tinc, you will need a GNU C compiler environment. Please
+ensure you have the latest stable versions of all the required libraries.

 
 
 Features
 
 
 Features


@@ -115,8 +116,7 @@ Support for routing IPv6 packets has been added. Just add Subnet lines with
 IPv6 addresses (without using :: abbreviations) and use ifconfig or ip (from
 the iproute package) to give the virtual network interface corresponding IPv6
 addresses. tinc does not provide autoconfiguration for IPv6 hosts, if you need
 IPv6 addresses (without using :: abbreviations) and use ifconfig or ip (from
 the iproute package) to give the virtual network interface corresponding IPv6
 addresses. tinc does not provide autoconfiguration for IPv6 hosts, if you need

-it use radvd or zebra. Tunneling IPv6 packets only works on Linux, FreeBSD,
-Windows and possibly OpenBSD.
+it use radvd or zebra.

 
 It is also possible to make tunnels to other tinc daemons over IPv6 networks,
 if the operating system supports IPv6.  tinc will automatically use both IPv6
 
 It is also possible to make tunnels to other tinc daemons over IPv6 networks,
 if the operating system supports IPv6.  tinc will automatically use both IPv6