README: add french version

Author: kemenaran

README.md

@@ -1,5 +1,9 @@
 ![Gem Version](https://badge.fury.io/rb/siret_validator.svg) ![build](https://github.com/CodeursenLiberte/siret_validator/actions/workflows/main.yml/badge.svg)
 
+> [!NOTE]
+>
+> Ce README est aussi [disponible en français](README_fr.md).
+
 # siret_validator
 
 This gem provides a Rails validator for french [SIRET numbers](https://entreprendre.service-public.fr/vosdroits/F32135?lang=en).

README_fr.md

@@ -1 +1,82 @@
-_TODO_
+![Gem Version](https://badge.fury.io/rb/siret_validator.svg) ![build](https://github.com/CodeursenLiberte/siret_validator/actions/workflows/main.yml/badge.svg)
+
+> [!NOTE]
+>
+> This README is also [available in english](README.md).
+
+# siret_validator
+
+Cette gem fournit un validateur Rails pour les [numéros SIRET](https://entreprendre.service-public.fr/vosdroits/F32135) français.
+
+## Fonctionnalités
+
+* Validation du format SIRET (14 chiffres),
+* Validation du checksum des SIRET classiques (via la somme de Luhn),
+* Validation du checksum des SIRET de La Poste (via la formule de checksum alternative),
+* Messages d'erreur localisés clairs,
+* Support de messages d'erreur personnalisés.
+
+## Installation
+
+Installez la gem et ajoutez-la au Gemfile de l'application en exécutant :
+
+```bash
+bundle add siret_validator
+```
+
+Si Bundler n'est pas utilisé pour gérer les dépendances, installez la gem en exécutant :
+
+```bash
+gem install siret_validator
+```
+
+Vous pouvez également intégrer la gem directement en copiant le fichier `lib/siret_validator.rb` dans votre répertoire `app/validators`.
+
+## Utilisation
+
+### Avec ActiveRecord
+
+```ruby
+class TaxesFilling < ApplicationRecord
+  validates :company_siret, siret: true
+end
+```
+
+### Avec ActiveModel
+
+```ruby
+class TaxesFilling
+  include ActiveModel::Validations
+  attr_accessor :company_siret
+  validates :company_siret, siret: true
+end
+```
+
+## I18n
+
+Par défaut, le validateur SIRET peut émettre deux messages d'erreur distincts :
+
+* `:wrong_siret_format` – lorsque la valeur n'est pas une chaîne de 14 chiffres.
+
+    _Le message est localisé via la clé i18n personnalisée `:wrong_siret_format`. Les locales française et anglaise sont incluses dans la gem._
+* `:invalid` – lorsque le checksum du SIRET est invalide.
+
+    _Le message est localisé via la clé i18n standard Rails `:invalid`._
+
+## Développement
+
+Après avoir cloné le dépôt, exécutez `bin/setup` pour installer les dépendances. Ensuite, lancez `bundle exec rake test` pour exécuter les tests.
+
+Pour installer cette gem sur votre machine locale, exécutez `bundle exec rake install`. Pour publier une nouvelle version, mettez à jour le numéro de version dans `siret_validator.gemspec`, puis exécutez `bundle exec rake release`. Cela créera un tag Git pour la version, poussera les commits et le tag créé, et publiera le fichier `.gem` sur [rubygems.org](https://rubygems.org).
+
+## Contribuer
+
+Les rapports de bugs et les pull requests sont les bienvenus sur GitHub à l'adresse https://github.com/CodeursenLiberte/siret_validator. Ce projet se veut un espace sûr et accueillant pour la collaboration ; les contributeurs sont tenus de respecter le [code de conduite](https://github.com/CodeursenLiberte/siret_validator/blob/main/CODE_OF_CONDUCT.md).
+
+## Licence
+
+Cette gem est mise à disposition sous [licence MIT](https://opensource.org/licenses/MIT).
+
+## Code de conduite
+
+Toute personne interagissant dans la base de code, les issues, les salons de discussion et les listes de diffusion du projet SiretFormatValidator est tenue de respecter le [code de conduite](https://github.com/[USERNAME]/siret_validator/blob/main/CODE_OF_CONDUCT.md).