From c3e29157217f3c4a841402b68e04d2c8fd7bc4f1 Mon Sep 17 00:00:00 2001
From: sebalix <seb@usr-src.org>
Date: Wed, 28 Jan 2015 14:49:43 +0100
Subject: [PATCH] [IMP] Module 'auditlog' - README.rst updated (based on the
 OCA template)

---
 auditlog/README.rst | 52 +++++++++++++++++++++++++++++++++++++--------
 1 file changed, 43 insertions(+), 9 deletions(-)

diff --git a/auditlog/README.rst b/auditlog/README.rst
index 907d0c245..060b16e48 100644
--- a/auditlog/README.rst
+++ b/auditlog/README.rst
@@ -1,11 +1,45 @@
-Track every user operation on data models
-=========================================
+Track user operation on data models
+===================================
 
-The administrator can subscribe rules to log ``create``, ``read``, ``write``
-and ``delete`` operations performed on any data models of the system.
+This module allows the administrator to log user operations performed on data
+models such as ``create``, ``read``, ``write`` and ``delete``.
 
-Copyright, author and licence
------------------------------
-    * Copyright: 2015, ABF OSIELL
-    * Author: Sebastien Alix
-    * Licence : AGPL-3 (http://www.gnu.org/licenses/)
+Usage
+=====
+
+Go to `Reporting / Audit / Rules` to subscribe rules. A rule defines which
+operations to log for a given data model.
+Then, check logs in the `Reporting / Audit / Logs` menu.
+
+For further information, please visit:
+
+ * https://www.odoo.com/forum/help-1
+
+Known issues / Roadmap
+======================
+
+ * log ``read`` operations
+ * log only operations triggered by some users (currently it logs all users)
+ * group logs by HTTP query (thanks to werzeug)?
+ * group HTTP query by user session?
+
+Credits
+=======
+
+Contributors
+------------
+
+* Sebastien Alix <sebastien.alix@osiell.com>
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://odoo-community.org
+
+This module is maintained by the OCA.
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
+
+To contribute to this module, please visit http://odoo-community.org.