harryw/raft

A simple Raft distributed consensus implementation in Ruby

raft's Issues

Trying to use it

Hi,

I wanted to do an experiment with this raft implementation gem but even the example with Goliath i can't get to work.
Is this something i can still use? If not, any advise on what i should use?

Thanks!

Documentation needs improvement, fully functioning examples would be fantastic.

Hello,

While trying to use this library, I have found that the documentation doesn't go into detail on many of the methods in this library. On top of that, the example in the Readme doesn't work straight out of the box and seems to imply a fair amount of pre-existing knowledge of the working pieces used to construct it.

It would be nice to have a working example script provided, as reading fully functioning code tends to be easier than piecing together a use case based on an incomplete implementation. I had hoped that the RDocs would have more information, but most of it seems to say something along the line of:

• my_method: returns value of attribute my_method.

This is not particularly useful, as it doesn't provide any context for how these items relate to each other, and when/where they should be used.

I hope the documentation will get fleshed out a little better, as I am very interested in using this gem.

Thank you!