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: add images to README.md #141

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

userkace
Copy link

@userkace userkace commented Dec 5, 2024

Description

This pull request enhances the main README.md file by incorporating images to improve user experience and showcase the application more effectively.
Adding visuals to the README can significantly increase user engagement and understanding.

Fixes # (issue)

It does not fix any current issue, but does provide a quick and impactful overview of the application's capabilities.

Checklist:

  • [✔️] I have followed the Conventional Commits guidelines for all my commits.
    • Example of a Conventional Commit message: feat: add new feature to enhance user experience

Added screenshots to showcase the application on readme
Fixed image format on readme
Was using png instead of jpg
Limited width of previews
Changed width and added break lines
Placed previews inside a table
Copy link

sonarqubecloud bot commented Dec 5, 2024

@rhenwinch
Copy link
Collaborator

Hi,

The repo used to have app previews on README before, but then I removed it so it wouldn't confuse people that the app hosts and stores media content.

I know that this is one of the rules when creating user engagement but like what I've said ^^, I don't want to mislead people.

I'll have to put this PR on hold for a while, sorry

@userkace
Copy link
Author

userkace commented Dec 5, 2024

I do understand not a lot of users tend to read (leading to many issues about providers and sources) and I respect your direction with it~

One way to maybe remove confusion is by moving the disclaimers above the previews
Maybe even add custom HTML to emphasize it

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.

2 participants