]> git.ipfire.org Git - thirdparty/sarg.git/commitdiff
Add a note about sorttable.js to README
authorFrédéric Marchal <fmarchal@users.sourceforge.net>
Tue, 1 Nov 2011 07:31:07 +0000 (07:31 +0000)
committerFrédéric Marchal <fmarchal@users.sourceforge.net>
Tue, 1 Nov 2011 07:31:07 +0000 (07:31 +0000)
Now, sorttable.js is distributed along with sarg.

README

diff --git a/README b/README
index 8b72d629f2d037c1ad77e61d616509d9bce16201..b6def549dabf6bec162a828910b3f9f5e62989ac 100644 (file)
--- a/README
+++ b/README
@@ -52,6 +52,21 @@ Installation
 
 Usage: sarg -h
 
+Sorttable.js
+------------
+
+Starting with sarg v2.3.2-pre2, a javascript is distributed along with sarg to
+dynamically sort the reports. It is sorttable.js written by Stuart Langridge
+and available at http://www.kryogenix.org/code/browser/sorttable/.  The version
+included with sarg contains some fixes and improvements over the original
+version. The patches have been reported to the author but he doesn't seem to
+support it any more.
+
+To use sorttable.js (or any other script including your own custom made
+script), simply copy it to your website and edit sarg.conf to point the
+sorttable option to the location of the script on your website. The path
+indicated in sarg.conf must be the path as seen by a client visiting your
+server.
 
 Translations
 ------------