version 0.4

[irssistats] / README

diff --git a/README b/README
index 46b6627..01aaf4f 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-irssistats 0.31
+irssistats 0.4
 site: http://royale.zerezo.com/programmation/irssistats/
 mail: royale@zerezo.com
 
@@ -7,7 +7,17 @@ make
 cp pix/*.png /path/to/webdir/
 
 usage:
-cat /path/to/file.log | ./irssistats channel maintainer language theme > /path/to/webdir/index.html
+cat /path/to/file.log | ./irssistats channel maintainer language theme [nickfile] > /path/to/webdir/index.html
+
+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"
+The nickfile must not contain any comments.
+You can also take a look at the "sample.nickfile.txt" in this package.
 
 links:
 http://torus.lnet.lut.fi/ircstats/