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

README.md lacks usage description #7

Closed
ghost opened this issue Jul 27, 2022 · 2 comments
Closed

README.md lacks usage description #7

ghost opened this issue Jul 27, 2022 · 2 comments

Comments

@ghost
Copy link

ghost commented Jul 27, 2022

The readme file should have examples of how to use the library as well as an overview of its API.

@ghost ghost changed the title README.md lack usage description README.md lacks usage description Jul 27, 2022
@ghost
Copy link
Author

ghost commented Jul 28, 2022

Also description on how to use PUB/SUB (or if it is supported at all) from a user's process is lacking.

@zuiderkwast
Copy link
Collaborator

I've added documentation and example to README. Looks good?

I've noticed that pubsub doesn't work so I must say it isn't supported. It works somewhat in some situation but we will probably change how it works. SUBSCRIBE to two channels (or more) at the same time causes the client to get out of sync, so the following commands get the reply for another command.

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

1 participant