Add ability to drop overly large packets

[onak.git] / README

diff --git a/README b/README
index 9bdfe8b5fc0a2fbe0445748996b64117affd51e5..c329b3b19554fee874949005ddf9417edd00bf47 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-onak 0.3.5
-Copyright 2003-2008 Project Purple. Written by Jonathan McDowell
+onak 0.5.0
+Copyright 2003-2016 Jonathan McDowell
 http://www.earth.li/projectpurple/progs/onak.html
 
 
@@ -54,15 +54,15 @@ Once make has completed you'll end up with various binaries:
 
 Config:
 
-I've finally added config file support. onak.conf is an example config;
-the main thing to change is the db_dir to whereever you want to put your
-database files. The configure script allows you to specific where it
-should live; by default it'll be PREFIX/etc/onak.conf.
+I've finally added config file support. onak.ini is an example config;
+the main thing to change is the location in the backend section to
+whereever you want to put your database files. The configure script allows
+you to specific where it should live; by default it'll be PREFIX/etc/onak.ini.
 
 
 Backends:
 
-Currently there is support for 5 different database backends:
+Currently there is support for 6 different database backends:
 
 * file
   The original backend. Very simple and ideal for testing. Stores each
@@ -75,12 +75,6 @@ Currently there is support for 5 different database backends:
   with a large number of keys. This may well be due to my use of it - if
   you can help speed it up info would be appreciated.
 
-* db2 (Berkeley libdb2)
-  Only added to provide the ability to run the pathfinder with a key
-  database produced by pksd. Currently only supports pulling keys out by
-  keyid - no key updating or searching by key test. Found to be
-  tempramental and prone to deadlock in the db2 library.
-
 * db4 (Berkeley libdb4)
   The currently preferred backend. Supports the full range of functions
   like the pg backend but is considerably faster. Also easier to setup
@@ -93,6 +87,10 @@ Currently there is support for 5 different database backends:
   subkey searching). Needs a good filesystem to get good performance
   though as it creates many, many files and links.
 
+* hkp
+  A proxying backend. No keys are stored locally; all fetch and store
+  requests are forwarded to the provided keyserver.
+
 
 Other keyservers:
 
@@ -138,15 +136,17 @@ onak lives at:
 
 http://www.earth.li/projectpurple/progs/onak.html
 
-Development is carried out using arch; you can access the repository
+Development is carried out using git; you can access the repository
 with something like:
 
-tla register-archive noodles@earth.li--2004-laptop \
-       http://www.earth.li/~noodles/arch/
-tla get -A noodles@earth.li--2004-laptop onak--mainline--0.3
+git clone git://the.earth.li/onak.git
+
+or it can be browsed via gitweb at:
+
+http://the.earth.li/gitweb/?p=onak.git;a=summary
 
 
 License:
 
-onak is distributed under the GNU Public License, a copy of which should
-have been provided with this archive as LICENSE.
+onak is distributed under the GNU Public License version 2, a copy of
+which should have been provided with this archive as LICENSE.