Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Improve README file with more details #40

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Sarrabah
Copy link
Collaborator

@Sarrabah Sarrabah commented Jan 23, 2025

Goal

This PR updates and improves the README file with more details to better explain the project's objectives, as outlined in issue #33.

Fixes #33

@Sarrabah Sarrabah changed the title Docs: Update README file with more details Docs: Improve README file with more details Jan 23, 2025
README.md Outdated Show resolved Hide resolved
Comment on lines +20 to +23
**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 .

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**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 .

Me semble redondant avec la phrase d'introduction.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Sarrabah Sarrabah requested a review from johanricher January 28, 2025 10:41
README.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Améliorer README
3 participants