Document the name of the collection created by Coal Mine.

quantopian · Mar 20, 2015 · 317099e · 317099e
1 parent be3bead
commit 317099e
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -139,7 +139,8 @@ Here's what can go in the config file:
 * [mongodb] - required
   * hosts - the first argument to pymongo's MongoClient or
     MongoReplicaSetClient
-  * database - database name
+  * database - database name. Coal Mine will create only one
+    collection in the database, called "canaries". 
   * username - must be specified, but can be blank if no
     authentication is required
   * password - must be specified, but can be blank if no