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

Real world example on README #1

Open
tiagostutz opened this issue Aug 7, 2023 · 2 comments
Open

Real world example on README #1

tiagostutz opened this issue Aug 7, 2023 · 2 comments

Comments

@tiagostutz
Copy link

Is your feature request related to a problem? Please describe.
Not exactly a problem, but if the README had some visual content it would make more clear what the tool can do (as it is visual related stuff).

Describe the solution you'd like
It would be really nice to have a short GIF with a video and the respective extractions showcasing the tool on README

Describe alternatives you've considered
Link to a youtube video showcasing, screenshots

What do you think?

@alexandrevl
Copy link
Owner

Excellent idea my friend! We added a examples/ folder with some examples but definitely we are going to add in README.md

@tiagostutz
Copy link
Author

Super! I would be glad to shoot a PR for this.
If a contribution for this issue makes sense, briefly describe where you it to be in the README and I'll add it and we can discuss the details on the PR review.

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

No branches or pull requests

2 participants