From fc6a17d74f8e476211bfea8485dbb1d4cc778c40 Mon Sep 17 00:00:00 2001
From: benjamin <benjamin@le-filament.com>
Date: Tue, 25 Jan 2022 09:45:56 +0100
Subject: [PATCH] [update] readme

---
 README.md | 41 ++++++++++++++++++++++++++++++++---------
 1 file changed, 32 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 90d54f5..ca74cc3 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,36 @@
-Partner geolocalize
-===================
+.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
+   :target: http://www.gnu.org/licenses/agpl
+   :alt: License: AGPL-3
 
-Contacts geolocation API to convert partner addresses into GPS coordinates.
 
-Configure
----------
-You can configure in General Settings the default provider of the geolocation API service.
+===================================
+Franch API Gouv Partner Geolocalize
+===================================
 
-A method `_call_<service>` should be implemented in object `base.geocoder` that accepts an address string as parameter and return (latitude, longitude) tuple for this to work.
-If no default provider is set, the first one will be used by default.
+Description
+===========
 
-An optional method `_geo_query_address_<service>` which takes address fields as parameters can be defined to encode the query string for the provider.
\ No newline at end of file
+This module adds French Data Gouv API in geolocation list.
+
+Usage
+=====
+
+In *Configuration > General Settings*, select **Adresse Data Gouv** option.
+
+Credits
+=======
+
+Contributors
+------------
+
+* Benjamin Rivier <benjamin@le-filament.com>
+
+
+Maintainer
+----------
+
+.. image:: https://le-filament.com/images/logo-lefilament.png
+   :alt: Le Filament
+   :target: https://le-filament.com
+
+This module is maintained by Le Filament
-- 
GitLab