diff --git a/README.md b/README.md index 3c98498..6b9d20d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ # Fr-format -A collection of validators to check data against french formats. +The standard library `fr-format` provides a collection of validators to check data against typical French formats. + +It has been initially developed for sharing validation functions between these two projects: + +* [validata](https://gitlab.com/validata-table) +* [csv-detective](https://github.com/datagouv/csv-detective) + +## Available formats + +Check out [this documentantion](./docs/formats.md) that lists all available formats. ## Installation @@ -10,6 +19,11 @@ The package is published on PyPI. Install with : ## Usage +**User story** + +As a fr-format user, you want to validate a value according to a given French format. This allows you to easily check if the data provided by your project users is valid or not . + +Here's an example of how to use fr-format: ```python from frformat import Departement, Options, Millesime @@ -29,12 +43,7 @@ For more details, consult the [Options](./src/frformat/options.py) data class. For better performance on big amounts of data, use in conjunction with numpy. -## Available formats - -Check out [this documentantion](./docs/formats.md) that lists all available formats. - ## Contributing Found a bug, want to propose a feature or a new format? See the [contribution guidelines](./CONTRIBUTING.md) on how to proceed! -