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

Documentation? #1

Closed
devinmatte opened this issue Jun 7, 2017 · 1 comment
Closed

Documentation? #1

devinmatte opened this issue Jun 7, 2017 · 1 comment

Comments

@devinmatte
Copy link

devinmatte commented Jun 7, 2017

I've been looking for a beanstalkd python engine, and yours seems to be the only one with Python 3.5+ support. However I don't really know how to use it due to the lack of documentation. If you could spin up some documentation on how to set up a basic implementation of it I'd greatly appreciate it. Especially because then I could use it, and possibly, contribute

Edit: I've been reading through the source code, and I understand how it works now. However having some documentation would still be very useful

@justinmayhew
Copy link
Owner

Initial documentation is now on Read the Docs: https://greenstalk.readthedocs.io/en/latest/

It's still a work in progress, but should definitely help people get up and running.

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

2 participants