Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
flowerinthenight committed Jun 15, 2023
1 parent 1c5a3e0 commit 58ddef8
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Similar projects:
* [lockgate](https://github.com/werf/lockgate) - Go
* [kettle](https://github.com/flowerinthenight/kettle) - Go

## Use cases
One use case for this library is leader election. If you want one host/node/pod to be the leader within a cluster/group, you can achieve that with this library. When the leader fails, it will fail over to another host/node/pod within a specific timeout.

## Usage
At the moment, the table needs to be created beforehand using the following DDL (`locktable` is just an example):
```SQL
Expand Down

0 comments on commit 58ddef8

Please sign in to comment.