# ExRaft

![Build Status](https://github.com/bajankristof/ex_raft/actions/workflows/main.yml/badge.svg?branch=main)

An Elixir implementation of the raft consensus protocol.

## Installation

The package can be installed by adding `ex_raft` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:ex_raft, "~> 0.1.1"}
  ]
end
```

## Documentation

You can find the online documentation at [https://hexdocs.pm/ex_raft](https://hexdocs.pm/ex_raft).
Documentation can also be generated with [ExDoc](https://github.com/elixir-lang/ex_doc).

## Getting started

Soon to be released...

## Contributing

All contributions must adhere to the guidelines below:

  * https://github.com/christopheradams/elixir_style_guide
  * https://github.com/christopheradams/elixir_style_guide#modules
  * https://hexdocs.pm/elixir/master/library-guidelines.html
  * https://hexdocs.pm/elixir/master/writing-documentation.html

## License

`ExRaft` source code is released under Apache License 2.0.
Check LICENSE file for more information.