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

Improve readme and docs with debouncers #496

Open
0xpr03 opened this issue Jun 16, 2023 · 0 comments
Open

Improve readme and docs with debouncers #496

0xpr03 opened this issue Jun 16, 2023 · 0 comments
Labels
B-doc improvement/fix for documentation

Comments

@0xpr03
Copy link
Member

0xpr03 commented Jun 16, 2023

Just a todo to add more explanation to notify's front readme and lib.rs.

Would be nice to directly give users more information about notify vs notify-debouncer-mini vs -full, that they exist and which one to choose. Searching for notify on crates.io also doesn't show more than notify itself, so this would definitely help.

The current readme is too detailed and diverges into FSevents, which isn't exactly beginner friendly.

Also add a link to the list of known issues from notify into the debouncers docs. Probably need to see which ones don't apply for debouncers.

@0xpr03 0xpr03 added the B-doc improvement/fix for documentation label Jun 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
B-doc improvement/fix for documentation
Projects
None yet
Development

No branches or pull requests

1 participant