version 0.42

[irssistats] / README

diff --git a/README b/README
index d2ee540..67ca6e8 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,26 @@
-irssistats 0.1
+irssistats 0.42
 site: http://royale.zerezo.com/programmation/irssistats/
 mail: royale@zerezo.com
 
-config:
-edit irssistats.c
-
 install:
 make
 cp pix/*.png /path/to/webdir/
 
 usage:
-cat /path/to/file.log | ./irssistats > /path/to/webdir/index.html
+cat /path/to/file.log | ./irssistats \#channel maintainer language theme [nickfile] > /path/to/webdir/index.html
+(don't forget to escape the '#' in the channel name)
+
+nickfile:
+Since version 0.4 of irssistats, you can use a nickfile to specify nicks to join.
+Each line of the nickfile contains the final nick and a regular expression.
+Examples :
+  royale  ^[Rr]oyale   : join nicks starting with "Royale" or "royale" to the final nick "royale"
+  royale  ^antoine$    : also join the nick "antoine" to the final nick "royale"
+  djakette  [Dd]ja     : join any nick that contains "Dja" or "dja" to final nick "djakette"
+  <NULL> ^bot\|royale$ : remove "bot|royale" from statistics
+The nickfile must not contain any comments.
+The <NULL> final nick will remove matching nicks from all statistics, except from "Some URLs" and "Some topics"...
+You can also take a look at the "sample.nickfile.txt" in this package.
 
 links:
 http://torus.lnet.lut.fi/ircstats/