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.

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

Remove Usage section from readme #420

Closed
Mossaka opened this issue Jul 1, 2022 · 1 comment · Fixed by #395
Closed

Remove Usage section from readme #420

Mossaka opened this issue Jul 1, 2022 · 1 comment · Fixed by #395

Comments

@Mossaka
Copy link

Mossaka commented Jul 1, 2022

It seems like the with-a-channel section in the readme is not reflecting the newest API design where it says that there is a Watcher::with_channel, but there is no such API in the docs. I understand that the current 5.0.0 is not stablized yet, but I suggest to remove the entire Usage section in the README and point the usage to the API docs to reduce confusions.
@Mossaka Mossaka changed the title Update readme to match the API documentation Remove Usage section from readme Jul 1, 2022
@JohnTitor
Copy link
Member

The issue will be fixed by #395.

@JohnTitor JohnTitor mentioned this issue Jul 20, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix readme and examples notify-rs/notify
2 participants
@Mossaka @JohnTitor