Documentation and improvements

1xyz / coolbeans

Coolbeans is a distributed work queue that implements the beanstalkd protocol.

Mozilla Public License 2.0

67 stars 6 forks source link

Documentation and improvements #4

Closed 1xyz closed 4 years ago

1xyz commented 4 years ago

Here are some documentation fixes for Readme

Add Motivation
Add Key Features section
Setting up a cluster manually on three machines, with an example. Refer https://github.com/rqlite/rqlite excellent documentation to get ideas
Durability of writing to the store
Also, see if you can generate godoc

cc: @jrgallelli

jrgallelli commented 4 years ago

In the motivation section, perhaps something along the lines of:

This project started with the desire to use beanstalkd because of its simplicity but, at the same time, ensure that it was replicated and highly available. Additionally, we wanted to solve some of the key problems we faced with setting up beanstalkd in a kubernetes environment, including sticky connections and balancing work across worker nodes.

1xyz commented 4 years ago

Also add simple instructions for multiple machines