docs: update README.md for Pole Emploi

Riminder · Jul 1, 2024 · 914618a · 914618a
1 parent 4f988f6
commit 914618a
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 11 deletions.
diff --git a/src/hrflow_connectors/connectors/breezyhr/README.md b/src/hrflow_connectors/connectors/breezyhr/README.md
@@ -10,7 +10,7 @@
 - [👏 Special Thanks](#-special-thanks)
 
 
-# 📝 About BreezyHR 
+# 📝 About BreezyHR
 
 BreezyHr is a software designed to assist teams in finding the right candidates, evaluating applicants, and making a hire more quickly.
 It helps streamline the recruitment process and identify the best fit for a position.
@@ -20,7 +20,7 @@ It helps streamline the recruitment process and identify the best fit for a posi
 <image src=https://user-images.githubusercontent.com/55802491/212358414-f29104b6-c54b-4f91-b376-1fe7b5fb8eb1.png width=90% height=100% >
 </p>
 
-# 📊 Data Flow 
+# 📊 Data Flow
 In this section, we outline the data flow between different components of the connector. The following schema provides a graphical representation of the data exchange process
 
 <p align="center">
@@ -51,9 +51,9 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
 <image src=https://user-images.githubusercontent.com/107410704/219009142-9fd3c7f5-97f5-43a9-b7af-0f358fa28bd5.png width=90% height=100% >
 </p>
 
-Once the connector module is imported, you can leverage all the different actions that it offers. 
+Once the connector module is imported, you can leverage all the different actions that it offers.
 
-For more code details checkout connector code 
+For more code details checkout connector code
 
 # 🔗 Useful Links
 
@@ -62,7 +62,7 @@ For more code details checkout connector code
 - 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/breezyhr) on our Github.
 
 
-# 👏 Special Thanks  
+# 👏 Special Thanks
 - 💻 HrFlow.ai :  [Limam VADHEL](https://github.com/limamvadhel) - Software Engineer
 - 💻 HrFlow.ai : [Leo FERRETTI](https://github.com/Sprenger07) - Software Engineer
 - 💻 HrFlow.ai :[Corentin DUCHENE](https://github.com/CorentinDuchene) - Software Engineer

diff --git a/src/hrflow_connectors/connectors/poleemploi/README.md b/src/hrflow_connectors/connectors/poleemploi/README.md
@@ -1,10 +1,33 @@
+# 📖 Summary
+- [📖 Summary](#-summary)
+- [📝 About Pôle emploi](#-about-pôle-emploi)
+- [📊 Data Flow](#-data-flow)
+- [🔌 Connector Actions](#-connector-actions)
+- [🐍 Quick Start Example](#-quick-start-example)
+- [🔗 Useful Links](#-useful-links)
+- [👏 Special Thanks](#-special-thanks)
 
-# Poleemploi Connector
 
-> Thanks to the Job Offers API, you can access all the job offers available on the Pôle emploi website at any time and in real time.
+# 📝 About Pôle emploi
+
+Access all the job offers available on the Pôle emploi website at any time and in real time.
+
+<p align="center">
+<image src=https://user-images.githubusercontent.com/107410704/213744087-8967fb2a-ccb1-45c5-8375-04942b4c43e4.jpg width=90% height=100% >
+</p>
+
+
+
+# 📊 Data Flow
+
+In this section, we outline the data flow between different components of the connector. The following schema provides a graphical representation of the data exchange process
+
+<p align="center">
+
+<image src=https://user-images.githubusercontent.com/107410704/213745057-c9d8a69d-d65f-4dd3-929c-5f5cbcabc1cc.jpg width=90% height=100% >
+</p>
 
 
-🔗 https://www.pole-emploi.fr/
 
 # 🔌 Connector Actions
 <p align="center">
@@ -14,4 +37,32 @@
 | [**Pull job list**](docs/pull_job_list.md) | Retrieves jobs via the ***Offres d'emploi v2*** API from the Pôle emploi website based on selection criteria set in the and send them to a ***Hrflow.ai Board***. |
 
 
-</p>
+</p>
+
+
+# 🐍 Quick Start Example
+
+
+To make sure you can successfully run the latest versions of the example scripts, you have to **install the package from PyPi**.
+To browse the examples of actions corresponding to released versions of 🤗 this connector, you just need to import the module like this :
+
+
+<p align="center">
+<image src=https://user-images.githubusercontent.com/107410704/219022492-3fae3597-3713-4e91-ae69-91a5d05764d6.png width=90% height=100% >
+</p>
+
+Once the connector module is imported, you can leverage all the different actions that it offers.
+
+For more code details checkout connector code
+
+
+
+# 🔗 Useful Links
+
+- 📄Visit [Pôle emploi](https://www.pole-emploi.fr/accueil/) to learn more.
+- ⚙️ API documentation : (https://pole-emploi.io/data/api/offres-emploi?tabgroup-api=documentation&doc-section=api-doc-section-rechercher-par-crit%C3%A8res)
+- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/poleemploi) on our Github.
+
+
+# 👏 Special Thanks
+- 💻 HrFlow.ai :  [Nedhir Ebnou](https://github.com/nedhirouebnou) - Software Engineer
diff --git a/src/hrflow_connectors/connectors/salesforce/README.md b/src/hrflow_connectors/connectors/salesforce/README.md
@@ -7,7 +7,7 @@
   - [**Push Profiles Action**](#push-profiles-action)
   - [**Pull Jobs Action**](#pull-jobs-action)
 - [🔗 Useful Links](#-useful-links)
-- [👍 Special Thanks](#-special-thanks)
+- [👏 Special Thanks](#-special-thanks)
 
 
 # 📝 About Salesforce
@@ -131,6 +131,6 @@ For more code details checkout connector code
 - 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/salesforce) on our Github.
 
 
-# 👍 Special Thanks
+# 👏 Special Thanks
 - 💻 HrFlow.ai : [the-forest-tree](https://github.com/the-forest-tree) - Software Engineer
 - 🤝 Salesforce : [Salesforce Developer Centers](https://developer.salesforce.com/)