From 8f2e91d857667ec9369a17115acf1a4b9a64240a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20Fastr=C3=A9?= <julien.fastre@champs-libres.coop>
Date: Mon, 10 Oct 2022 10:34:48 +0000
Subject: [PATCH] doc for PickPostalCode vue component

---
 .../vuejs/PickPostalCode/PickPostalCode.md    | 27 ++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/src/Bundle/ChillMainBundle/Resources/public/vuejs/PickPostalCode/PickPostalCode.md b/src/Bundle/ChillMainBundle/Resources/public/vuejs/PickPostalCode/PickPostalCode.md
index 93dcf1816..501e96983 100644
--- a/src/Bundle/ChillMainBundle/Resources/public/vuejs/PickPostalCode/PickPostalCode.md
+++ b/src/Bundle/ChillMainBundle/Resources/public/vuejs/PickPostalCode/PickPostalCode.md
@@ -1,4 +1,29 @@
 # Pickpostalcode
 
+Allow to pick a postal code.
+
+In use with module `mod_pick_postal_code`, associated  with `PickPostalCodeType` in php.
+
 ## Usage
-    <PickPostalCode />
+    
+    `<pick-postal-code @select-city="onCitySelected" @removeCity="onCityRemoved" :picked="city"></pick-postal-code>`
+
+## Props
+
+* `picked`: the city picked. A javascript object (a city). Null if empty.
+* `country`: country to restraint search on picked. May be null.
+
+## Emits
+
+### `selectCity`
+
+When a city is onCitySelected.
+
+Argument: a js object, representing a city
+
+### `removeCity`
+
+When a city is removed.
+
+
+Argument: a js object, representing a city