[IMP] Module 'auditlog' - README.rst updated (based on the OCA template)

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``
+This module allows the administrator to log user operations performed on data
-and ``delete`` operations performed on any data models of the system.
+models such as ``create``, ``read``, ``write`` and ``delete``.
 
-Copyright, author and licence
+Usage
------------------------------
+=====
-    * Copyright: 2015, ABF OSIELL
+
-    * Author: Sebastien Alix
+Go to `Reporting / Audit / Rules` to subscribe rules. A rule defines which
-    * Licence : AGPL-3 (http://www.gnu.org/licenses/)
+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.