Merge pull request #674 from akretion/12.0-readme-l10n_br_zip_correios

[12.0] l10n_br_zip_correios Update README infos

l10n_br_zip_correios/README.rst

@@ -1,84 +1,97 @@
-.. 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
-
-===================================================================
-Módulo Para Busca do CEP através do webservice dos correios
-===================================================================
-
-This module realize a request in Brazilian Correios webservice searching zip codes
-inserted by user and fill address fields with the returned data.
-
-It provide this search button on view of partners and view of companies.
+===================================================
+Address from Brazilian Localization ZIP by Correios
+===================================================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! 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%2Fl10n--brazil-lightgray.png?logo=github
+    :target: https://github.com/OCA/l10n-brazil/tree/12.0/l10n_br_zip_correios
+    :alt: OCA/l10n-brazil
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/l10n-brazil-12-0/l10n-brazil-12-0-l10n_br_zip_correios
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/124/12.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+Módulo implementa pesquisa de CEP utilizando o WebService dos Correios
+
+**Table of contents**
+
+.. contents::
+   :local:
 
 Installation
 ============
 
-To install this module, you need to:
-
-* do this ...
+Este módulo depende do módulo l10n_br_zip.
 
 Configuration
 =============
 
-This module makes use of external python libraries to perform their search routines:
-
- * suds: `pip install suds`
+Não é necessário nenhuma configuração para este módulo consultar o WebService dos Correios.
 
 Usage
 =====
 
-To use this module, you need to:
-
-* go to ...
-
-.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
-   :alt: Try me on Runbot
-   :target: https://runbot.odoo-community.org/runbot/{repo_id}/{branch}
-
-
-.. repo_id is available in https://github.com/OCA/maintainer-tools/blob/master/tools/repos_with_ids.txt
-.. branch is "8.0" for example
+Nos cadastros de parceiro, empresa e prospecto ao preencher o campo CEP pode ser pesquisado pressionando o botão do lado para pesquisar o CEP e autocompletar os dados de Logradouro, Bairro, Cidade e Estado com o resultado da pesquisa dos Correios.
 
 Known issues / Roadmap
 ======================
 
-TODO
+* Ele módulo deve ser refatorado para ser unido ao módulo l10n_br_zip e utilizar a biblioteca pyhton pycep_correios
 
 Bug Tracker
 ===========
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/l10n-brazil/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 `here <https://github.com/OCA/
-l10n-brazil/issues/new?body=module:%20
-l10n_br_crm_zip_correios%0Aversion:%20
-8.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/l10n-brazil/issues/new?body=module:%20l10n_br_zip_correios%0Aversion:%2012.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
+~~~~~~~
+
+* KMEE
+
 Contributors
-------------
+~~~~~~~~~~~~
 
 * Michell Stuttgart <michellstut@gmail.com>
 * Luis Felipe Miléo <mileo@kmee.com.br>
 * Carlos Alberto Cipriano Korovsky <carlos.korovsky@uktech.com.br>
 * Hendrix Costa <hendrix.costa@kmee.com.br>
 
 
-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 http://odoo-community.org.
+This module is part of the `OCA/l10n-brazil <https://github.com/OCA/l10n-brazil/tree/12.0/l10n_br_zip_correios>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

l10n_br_zip_correios/readme/CONFIGURE.rst

@@ -0,0 +1 @@
+Não é necessário nenhuma configuração para este módulo consultar o WebService dos Correios.

l10n_br_zip_correios/readme/CONTRIBUTORS.rst

@@ -0,0 +1,5 @@
+* Michell Stuttgart <michellstut@gmail.com>
+* Luis Felipe Miléo <mileo@kmee.com.br>
+* Carlos Alberto Cipriano Korovsky <carlos.korovsky@uktech.com.br>
+* Hendrix Costa <hendrix.costa@kmee.com.br>
+

l10n_br_zip_correios/readme/DESCRIPTION.rst

@@ -0,0 +1 @@
+Módulo implementa pesquisa de CEP utilizando o WebService dos Correios

l10n_br_zip_correios/readme/INSTALL.rst

@@ -0,0 +1 @@
+Este módulo depende do módulo l10n_br_zip.

l10n_br_zip_correios/readme/ROADMAP.rst

@@ -0,0 +1 @@
+* Ele módulo deve ser refatorado para ser unido ao módulo l10n_br_zip e utilizar a biblioteca pyhton pycep_correios

l10n_br_zip_correios/readme/USAGE.rst

@@ -0,0 +1 @@
+Nos cadastros de parceiro, empresa e prospecto ao preencher o campo CEP pode ser pesquisado pressionando o botão do lado para pesquisar o CEP e autocompletar os dados de Logradouro, Bairro, Cidade e Estado com o resultado da pesquisa dos Correios.