docs: improve Readme

README.md

@@ -1,11 +1,41 @@
-# eimis-prosante-connect-module
+# EIMIS Pro Santé Connect module
 
-A synapse module used by EIMIS to filter and map users registered through Prosanté Connect
+![Matrix](https://img.shields.io/badge/matrix-000000?logo=Matrix&logoColor=white)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/eimis-ans/eimis-prosante-connect-module/lint.yml?label=lint&logo=github)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/eimis-ans/eimis-prosante-connect-module/test.yml?label=test&logo=github)
+![License](https://img.shields.io/badge/license-MIT-blue.svg)
+
+A synapse module used by EIMIS to filter and map users registered through Pro Santé Connect
 
 ## OIDC configuration
 
 Todo: how to configure keycloak to have the same token than PSC?
 
+## Synapse configuration
+
+```yaml
+  - idp_id: psc
+    idp_name: "Pro Santé Connect"
+    idp_icon: "{{ mxc_psc.stdout }}"
+    discover: false
+    issuer: "{{ prosante_connect.issuer }}"
+    authorization_endpoint: "{{ prosante_connect.authorization_endpoint }}"
+    token_endpoint: "{{ prosante_connect.token_endpoint }}"
+    userinfo_endpoint: "{{ prosante_connect.userinfo_endpoint }}"
+    jwks_uri: "{{ prosante_connect.jwks_uri }}"
+    client_id: "{{ prosante_connect.client_id }}"
+    client_secret: "{{ prosante_connect.client_secret }}"
+    user_profile_method: userinfo_endpoint
+    scopes: ["openid", "scope_all"]
+    user_mapping_provider:
+      module: synapse.psc_mapping_provider.ProsanteConnectMappingProvider
+      config:
+        localpart_template: "{% raw %}{{ user.preferred_username }}{% endraw %}"
+        display_name_template: "{% raw %}{{ user.given_name }} {{ user.family_name }}{% endraw %}"
+        email_template: "{% raw %}{{ user.email }}{% endraw %}"
+    backchannel_logout_enabled: true # Optional
+```
+
 ## User info
 
 <https://industriels.esante.gouv.fr/produits-et-services/pro-sante-connect/userinfo>