path: root/README
authorSergey Poznyakoff <>2014-11-12 09:31:42 (GMT)
committer Sergey Poznyakoff <>2014-11-12 09:31:42 (GMT)
commitbcce955697d68e0daf93e8a64ec2e6a5bb107d1d (patch) (side-by-side diff)
tree36266843893bac07d8fd0f1091e37b184f67bda6 /README
parent0a8d5fdb52f479e4526ca7ee2ddfd0df2a202928 (diff)
Diffstat (limited to 'README') (more/less context) (ignore whitespace changes)
1 files changed, 20 insertions, 1 deletions
diff --git a/README b/README
index 68fbe04..2ddf2b7 100644
--- a/README
+++ b/README
@@ -2,6 +2,24 @@ Vmod-dbrw README
Copyright (C) 2013-2014 Sergey Poznyakoff
See the end of file for copying conditions.
+* Introduction
+This file contains brief information about configuring, testing
+and running vmod-dbrw. It is *not* intended as a replacement
+for the documentation and is provided as a brief reference only.
+The complete documentation for vmod-dbrw is available in
+doc/ subdirectory. To read it without installing the package
+run `info -f doc/'. After the package is installed
+the documentation can be accessed running `info vmod-dbrw'.
+A shorter version of the documentation is provided in manpage
+format, in file doc/vmod-dbrw.3. After installation, it will
+become available by running `man vmod-dbrw'.
+An online copy of the documentation in various formats is
+available at
* Overview
Vmod-dbrw is a Varnish Cache module implementing database-driven
@@ -12,7 +30,8 @@ structure, considerably speeding up their handling. Another advantage
of this approach is that rewrite rules stored in a database are easier
to maintain.
-This version supports MySQL and PostgreSQL databases.
+This version supports MySQL and PostgreSQL databases and compiles for
+both Varnish 3.x and 4.x.
* Example

Return to:

Send suggestions and report system problems to the System administrator.