Update README and HACKING.

[libradsec.git] / lib / README

diff --git a/lib/README b/lib/README
index e6b9956..37a5d16 100644 (file)
--- a/lib/README
+++ b/lib/README
@@ -1,11 +1,19 @@
-libradsec is a non-working RADIUS library doing UDP, TCP, TLS and
-DTLS.
+libradsec is a RADIUS library for clients doing RADIUS over UDP or
+TLS. The goal is to add support for writing servers (and thus
+proxies) and to add transports TCP and DTLS.
+
+
+The canonical pickup point is
+http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
+
+
+The source code is licensed under a 3-clause BSD license. See LICENSE.
+
 
 libradsec depends on 
-- libradius from the FreeRADIUS freeradius-server
-- libevent2
 - libconfuse
-- openssl (if configured with tls or dtls support)
+- libevent2
+- openssl (if configured with --enable-tls)
 
 
 To compile the library and the examples, do something like
@@ -13,14 +21,14 @@ To compile the library and the examples, do something like
  sh autogen.sh && ./configure && make
 
 If any of the libraries are not found, try setting environment
-variable LDFLAGS at configure time
+variable LDFLAGS at configure time like so:
 
- LDFLAGS="-L/usr/lib/freeradius -L/usr/local/lib" ./configure
+  LDFLAGS="-L/usr/local/lib" ./configure --enable-tls
 
 
 The parts of the library which has been tested has been so on Linux
-(Ubuntu 10.04) with libfreeradius2 (2.1.8+dfsg-1ubuntu1), libconfuse0
-(2.6-2) and libevent-2.0.7-rc-dev (http://monkey.org/~provos/).
+(Debian) with libconfuse (2.7), libevent (2.0.19) and OpenSSL
+(1.0.1c).
 
 The file HACKING contains more detailed info on the state of the
 various parts of the library.