Skip to content

Commit

Permalink
Add README badges
Browse files Browse the repository at this point in the history
  • Loading branch information
fjarri committed Oct 12, 2024
1 parent f6cfb1f commit d1182c7
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Round-based distributed protocols

[![crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
![License][license-image]
[![Build Status][build-image]][build-link]
[![Coverage][coverage-image]][coverage-link]

*The body is round*

## Goals
Expand All @@ -21,3 +27,14 @@ We try to find the balance between supporting the majority of protocols and keep
- On finalization, a round can return the result, halt with an error, or continue to another round.
- A round can generate several direct messages (each going to a specific party).
- Additionally, a round can generate one echo-broadcasted message, for which it will be ensured that each party received the same message.


[crate-image]: https://img.shields.io/crates/v/manul.svg
[crate-link]: https://crates.io/crates/manul
[docs-image]: https://docs.rs/manul/badge.svg
[docs-link]: https://docs.rs/manul/
[license-image]: https://img.shields.io/crates/l/manul
[build-image]: https://github.com/entropyxyz/manul/workflows/manul/badge.svg?branch=master&event=push
[build-link]: https://github.com/entropyxyz/manul/actions?query=workflow%3Amanul
[coverage-image]: https://codecov.io/gh/entropyxyz/manul/branch/master/graph/badge.svg
[coverage-link]: https://codecov.io/gh/entropyxyz/manul

0 comments on commit d1182c7

Please sign in to comment.