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

Improving the "README" understanding for non-technical users #15

Open
Nickel14 opened this issue Apr 24, 2024 · 1 comment
Open

Improving the "README" understanding for non-technical users #15

Nickel14 opened this issue Apr 24, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Nickel14
Copy link

What would you like to be added?

First thanks you for your plugin, very useful!!
I suggest to rebuild the "ReadMe" file to improve the readability and the understandability of the plugins.

I'm not a technician and for me it's been very difficult to understand how to use some features of the plugin. Now i understand more, but still something is not clear.
For example, the modifier of the filter "Strict, Wildcard and Regex" what are they, and how to use it?
Or another example, how to use properly a "Tag patter".

Maybe isn't a priority issue, but to broaden the use of the plugin to non-technicians users, it could be a usefull thing.

Thanks again for your work

Why is this needed?

A remaking of the "readMe" file, to improve the understandibility and the readability.

@kelszo
Copy link
Owner

kelszo commented May 12, 2024

Yes this is a great idea, I will try to rewrite the README. Most likely I will include some examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants