Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
simbo1905 authored Dec 27, 2024
1 parent 9aa79f6 commit 0520eb0
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,21 @@
This repository contains a Java library that implements the Paxos algorithm as described in Leslie Lamport's 2001
paper [Paxos Made Simple](https://lamport.azurewebsites.net/pubs/paxos-simple.pdf).
It aims to be rigorous in terms of safety preferring to mark a node as crashed rather than ignoring any possible safety
violation.
violation.

This library aims to be a toolkit to help you to not have to write much code at all to run a cluster of nodes that
replicate a log of commands. Yet it will be modular in nature so that you can assemble your own custom solution that
only uses the core protocol messages and the code algorithm logic.

To use this library:

* You will need to implement the `Journal` interface to persist the state of the algorithm. This can be tables (or
documents or key-values) in the database that your application uses.
* At this time you will need to set up the cluster membership manually. You will need to assign a unique node identifier
to each node in the cluster.
* This library is designed to be transport agnostic. Examples of plugging in network transport as either QUIC or TCP are
planned.
* This library is designed to be transport agnostic. Examples of plugging in network transport as either QUIC, TCP and
a lean UDP implementation inspired by QUIC are planned.

This library aims to be a toolkit to help you to not have to write much code at all to run a cluster of nodes that
replicate an ordered sequence of appliation commands. Yet it modular in nature so that you can assemble your own custom solution that
only uses the core protocol messages and the code algorithm logic.

At this the time:

Expand Down

0 comments on commit 0520eb0

Please sign in to comment.