Skip to content

Improve readme with extended information #131

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Sep 23, 2025
Merged

Improve readme with extended information #131

merged 6 commits into from
Sep 23, 2025

Conversation

matthieucan
Copy link
Contributor

No description provided.

jochemvandooren
jochemvandooren reviewed Sep 22, 2025
View reviewed changes
Copy link
Contributor

@jochemvandooren jochemvandooren left a comment

Choose a reason for hiding this comment

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

Nice, great improvements 🖐️ Left small comments.

Also I think showcasing the output at the start of the README makes a lot of sense; when I look into new tools I always look for a practical use-case first, before reading the actual README

@matthieucan
Copy link
Contributor Author

Also I think showcasing the output at the start of the README makes a lot of sense; when I look into new tools I always look for a practical use-case first, before reading the actual README

I added another (simpler) example at the top. PTAL!

jochemvandooren
jochemvandooren reviewed Sep 23, 2025
View reviewed changes
Copy link
Contributor

@jochemvandooren jochemvandooren left a comment

Choose a reason for hiding this comment

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

Perfect! New look 😎

@matthieucan matthieucan merged commit 47cf9d3 into master Sep 23, 2025
4 checks passed
@matthieucan matthieucan deleted the matthieucan/better-readme branch September 23, 2025 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jochemvandooren jochemvandooren jochemvandooren approved these changes

@sercancicek sercancicek Awaiting requested review from sercancicek

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@matthieucan @jochemvandooren