From 2d60760bb1695b549c38546b49dc2074a01fddba Mon Sep 17 00:00:00 2001
From: Guillaume DOTT <guillaume.dott@lafourmi-immo.com>
Date: Wed, 29 May 2013 11:17:43 +0200
Subject: [PATCH] Add infos in README.md

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index c44f85c..c88c8b6 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,21 @@ To define a new format, add this in an initializer :
 RailsBigBrother.format = "new_format"
 ```
 
+### User and controller info
+
+To fill user and controller info, you need to define two methods in your `ApplicationController`
+```ruby
+def big_brother_user
+  ''
+end
+
+def big_brother_infos
+  {}
+end
+```
+`big_brother_user` must return a string.
+`big_brother_infos` can return a string, an array or a hash.
+
 ### Choose events to log
 
 You can choose which events to log with the `on` option. For example :