Bump version number to 1.0.2-pre.

[cubemap] / README

diff --git a/README b/README
index 4410010d148cde515898ffb7af9b49ddff91a97b..4d5d68012106dc25f63e75039a70c6116f2f6173 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 Cubemap is a high-performance, high-availability video reflector,
-specifically made for use with VLC. It is currently in alpha stage.
+specifically made for use with VLC.
 
 A short list of features:
 
@@ -13,6 +13,9 @@ A short list of features:
    (unless you delete the stream they are watching, of course).
    Cubemap also survives the encoder dying and reconnecting.
  - Per-stream fwmark support, for TCP pacing through tc (separate config needed).
+ - Support for setting max pacing rate through the fq packet scheduler
+   (obsoletes the previous point, but depends on experimental kernel patches
+   that will hit Linux in 3.13 at the earliest)
  - Reflects anything VLC can reflect over HTTP, even the muxes VLC
    has problems reflecting itself (in particular, FLV).
  - IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
@@ -42,6 +45,20 @@ are OK, and then exec() the new version, which deserializes everything and
 keeps going.
 
 
+Munin plugins:
+
+To activate these, symlink them into /etc/munin/plugins. If you don't put
+the files in the expected default locations (as done by 'make install'),
+you probably want some configuration in /etc/munin/plugin-conf.d/cubemap or
+similar, like this:
+
+[cubemap*]
+user <something>
+env.cubemap_config /etc/cubemap/cubemap.config
+env.cubemap_stats /var/lib/cubemap/cubemap.stats
+env.cubemap_input_stats /var/lib/cubemap/cubemap-input.stats
+
+
 Legalese: 
 
 Copyright 2013 Steinar H. Gunderson <sgunderson@bigfoot.com>.