From 9d43caefaabc5f8bc760692b82391b8074193f1f Mon Sep 17 00:00:00 2001
From: Thomas Lake <tswsl1989@sucs.org>
Date: Thu, 23 Aug 2012 10:00:20 +0100
Subject: [PATCH] Add documentation for BiomeOverlay

Have stuck with 'color' as the preferred spelling...
---
 docs/config.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/config.rst b/docs/config.rst
index 6573cb9..da5e4bd 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -802,7 +802,20 @@ MineralOverlay
 
             MineralOverlay(minerals=[(64,(255,255,0)), (13,(127,0,127))])
 
+BiomeOverlay
+    Color the map according to the biome at that point. Either use on
+    top of other modes or on top of ClearBase to create a pure overlay.
 
+    **Options**
+
+    biomes
+        A list of ("biome name", (r, g, b)) tuples to use as colors. Any
+        biome not specified won't be highlighted. If not provided then 
+        a default list of biomes and colors is used.
+
+        Example::
+
+            BiomeOverlay(biomes=[("Forest", (0, 255, 0)), ("Desert", (255, 0, 0))])
 
 Defining Custom Rendermodes
 ---------------------------