From 53ae7ee48f750bc121ba3ee5cf5eec3b3be96962 Mon Sep 17 00:00:00 2001
From: Pierre Verkest <pverkest@anybox.fr>
Date: Fri, 9 Jan 2015 16:40:11 +0100
Subject: [PATCH] Add documentation in the module description

---
 materialized_sql_view/__openerp__.py | 46 ++++++++++++++++++++++++++--
 1 file changed, 44 insertions(+), 2 deletions(-)

diff --git a/materialized_sql_view/__openerp__.py b/materialized_sql_view/__openerp__.py
index 51e98579278..0d5cb124c3a 100644
--- a/materialized_sql_view/__openerp__.py
+++ b/materialized_sql_view/__openerp__.py
@@ -26,8 +26,50 @@
     'version': '0.0.1',
     'category': 'Tools',
     'description': """
-        This  v7.0 odoo module, add utilities to manage materialized SQL view
-        and add necessary user interface to interact with.
+=====================
+Materialized SQL VIEW
+=====================
+
+This odoo module, add utilities to manage materialized SQL view
+and necessary user interface to interact with.
+
+How to use it
+-------------
+
+You can have a look to `the basic example
+<https://github.com/OCA/server-tools/blob/8.0/test_materialized_sql_view/model/
+model_test_using_sql_mat_view.py>`_,
+used in test module: `test_materialized_sql_view`.
+
+You can etheir add cron to refresh the materialized view periodicly,
+`here <https://github.com/OCA/server-tools/blob/8.0/test_materialized_sql_view/
+data/ir_cron.xml>`
+an example on the previous model
+
+
+Features
+--------
+
+* UI to manage materialized Sql view, and manually launch refresh
+    - add `Materialized sql view Manager` group to your expected user.
+    - Go through `Settings > Technical > Database Structure >
+      Materialized SQL view` menu to manage materialized sql views
+* Abstract class, to help developer to create materialized sql view
+* Use postgresql materialized view if pg >= 9.3.0.
+* Manage when pg version changed
+* Recreate materialized sql view only if necessary, one of those change:
+  - sql materialized view name `_sql_mat_view_name`, this is used as search key
+    (so if you change it, you have to manage how to clean unecessary views and
+    records)
+  - sql definition has changed `_sql_view_definition`
+  - sql view name has changed `_sql_view_name`
+  - database version has changed
+
+
+TODO
+----
+
+* Add UI on models based on materialized view. Specialy on dashboards
     """,
     'author': 'Pierre Verkest',
     'depends': [