Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lipinskipawel committed Nov 6, 2023
1 parent 397fccb commit fa365be
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
# Unofficial java client for [Maelstrom] server

Example of usage can be found in [lipinskipawel/whirlpool].

[Maelstrom]: https://github.com/jepsen-io/maelstrom

## How to release maelstrom-java library
[lipinskipawel/whirlpool]: https://github.com/lipinskipawel/whirlpool

## Features

Release process is semi-automated. It begins by adding a tag version (e.g. `v0.1.0`) to a specific commit and assigning
version to `version` in `build.gradle.kts`. Tagged commit will be release as a new version of library.
Currently, we are supporting 3 workloads

Next release have to be triggered manually by Github action release.
- echo
- unique-ids
- broadcast

After that Github workflow will react on the release and publish library to Maven Central Repository.
The rest of them are to be done

- g-counter
- kafka
- txn-rw-register

## License

This project is [MIT] licensed.

[MIT]: LICENSE

0 comments on commit fa365be

Please sign in to comment.