[UPD] Update Readme and kpi/images

kpi/README.rst

@@ -1,10 +1,29 @@
-.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
-   :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
-   :alt: License: AGPL-3
+=========================
+Key Performance Indicator
+=========================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-tools/tree/11.0/kpi
+    :alt: OCA/server-tools
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-kpi
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/253/11.0
+    :alt: Try me on Runbot
 
-===
-KPI
-===
+|badge1| |badge2| |badge3| |badge4|
 
 This module provides the basis for creating key performance indicators,
 including static and dynamic thresholds (SQL query or Python code),
@@ -22,6 +41,12 @@ A threshold is a list of ranges and a range is:
 * a maximum value (fixed, sql query or python code)
 * color (RGB code like #00FF00 for green, #FFA500 for orange, #FF0000 for red)
 
+
+**Table of contents**
+
+.. contents::
+   :local:	
+
 Configuration
 =============
 
@@ -32,11 +57,9 @@ Users must be added to the appropriate groups within Odoo as follows:
 Usage
 =====
 
+Example of usage:
 https://www.youtube.com/watch?v=OC4-y2klzIk
 
-.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
-   :alt: Try me on Runbot
-   :target: https://runbot.odoo-community.org/runbot/128/9.0
 
 Known issues / Roadmap
 ======================
@@ -48,12 +71,16 @@ Bug Tracker
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20kpi%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
 
 Credits
 =======
 
 Contributors
-------------
+~~~~~~~~~~~~
 
 * Daniel Reis <dreis.pt@hotmail.com>
 * Glen Dromgoole <gdromgoole@tier1engineering.com>
@@ -62,17 +89,19 @@ Contributors
 * Gervais Naoussi <gervaisnaoussi@gmail.com>
 * Iván Todorovich <ivan.todorovich@gmail.com>
 
-Maintainer
-----------
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
 
 .. image:: https://odoo-community.org/logo.png
    :alt: Odoo Community Association
    :target: https://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 https://odoo-community.org.
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/11.0/kpi>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

kpi/readme/CONTRIBUTORS.rst

@@ -0,0 +1,6 @@
+* Daniel Reis <dreis.pt@hotmail.com>
+* Glen Dromgoole <gdromgoole@tier1engineering.com>
+* Loic Lacroix <loic.lacroix@savoirfairelinux.com>
+* Sandy Carter <sandy.carter@savoirfairelinux.com>
+* Gervais Naoussi <gervaisnaoussi@gmail.com>
+* Iván Todorovich <ivan.todorovich@gmail.com>

kpi/readme/DESCRIPTION.rst

@@ -0,0 +1,15 @@
+This module provides the basis for creating key performance indicators,
+including static and dynamic thresholds (SQL query or Python code),
+on local and remote data sources.
+
+The module also provides the mecanism to update KPIs automatically.
+A scheduler is executed every hour and updates the KPI values, based
+on the periodicity of each KPI. KPI computation can also be done
+manually.
+
+A threshold is a list of ranges and a range is:
+
+* a name (like Good, Warning, Bad)
+* a minimum value (fixed, sql query or python code)
+* a maximum value (fixed, sql query or python code)
+* color (RGB code like #00FF00 for green, #FFA500 for orange, #FF0000 for red)

kpi/readme/USAGE.rst

@@ -0,0 +1,2 @@
+Example of usage:
+https://www.youtube.com/watch?v=OC4-y2klzIk