[UPD] README.rst

web_widget_color/README.rst

@@ -1,5 +1,29 @@
-Color widget for Odoo web client
+================
-================================
+Web Widget Color
+================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! 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-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
+    :target: https://github.com/OCA/web/tree/11.0/web_widget_color
+    :alt: OCA/web
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/web-11-0/web-11-0-web_widget_color
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/162/11.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
 
 This module aims to add a color picker to Odoo.
 
@@ -27,6 +51,15 @@ Features
   |listview|
 
 
+.. |picker| image:: ./images/picker.png
+.. |formview| image:: ./images/form_view.png
+.. |listview| image:: ./images/list_view.png
+
+**Table of contents**
+
+.. contents::
+   :local:
+
 Usage
 =====
 
@@ -58,43 +91,64 @@ In the view declaration, put widget='color' attribute in the field tag::
     </field>
     ...
 
-.. |picker| image:: ./images/picker.png
+Widget Options::
-.. |formview| image:: ./images/form_view.png
-.. |listview| image:: ./images/list_view.png
 
-.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
+    - readonly_mode
-   :alt: Try me on Runbot
+        - 'default' > Color Box + text
-   :target: https://runbot.odoo-community.org/runbot/162/11.0
+        - 'color' > Only Color Box
+        - 'text' > Only Text
+    ...
+    <field name="arch" type="xml">
+        <tree string="View name">
+            ...
+            <field name="color" widget="color" options="{'readonly_mode': 'color'}"/>
+            ...
+        </tree>
+    </field>
+    ...
 
 Bug Tracker
 ===========
 
-Bugs are tracked on `GitHub Issues
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
-<https://github.com/OCA/OCA/issues>`_. In case of trouble, please
+In case of trouble, please check there if your issue has already been reported.
-check there if your issue has already been reported. If you spotted it first,
+If you spotted it first, help us smashing it by providing a detailed and welcomed
-help us smashing it by providing a detailed and welcomed feedback.
+`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_color%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
 =======
 
+Authors
+~~~~~~~
+
+* Savoir-faire Linux
+* Anybox
+* Taktik SA
+* Sudokeys
+
 Contributors
-------------
+~~~~~~~~~~~~
 
 * Adil Houmadi <adil.houmadi@gmail.com>
 * Enric Tobella <etobella@creublanca.es>
 * Nicolas JEUDY (Sudokeys) <https://www.github.com/njeudy>
+* Alexandre Díaz <dev@redneboa.es>
 
-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/web <https://github.com/OCA/web/tree/11.0/web_widget_color>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.