Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: List supported and WIP protocols #516

Merged
merged 3 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ The first intended use of Mir is as a scalable and efficient
and, potentially, as a Byzantine fault-tolerant ordering service in Hyperledger Fabric.
However, Mir hopes to be a building block of a next generation of distributed systems, being used by many applications.

Currently Mir includes an implementation of the [Trantor](/pkg/trantor) modular state machine replication system,
but work is under way to bring other protocols into Mir such as
[Granite](#515) and
[Alea-BFT](https://github.com/abread/mir/tree/alea/pkg/alea).

## Nodes, Modules, and Events

Mir is a framework for implementing distributed protocols (also referred to as distributed algorithms)
Expand Down Expand Up @@ -152,7 +157,7 @@ To get started using (and contributing to) Mir, in addition to this README, we r
(concretely the `multisigcollector`).

To learn about the first complex system being built on Mir,
have a look at [Trantor](https://hackmd.io/P59lk4hnSBKN5ki5OblSFg?view), a complex SMR syste being implemented using Mir.
have a look at [Trantor](/pkg/trantor), a complex SMR system being implemented using Mir.

## Contributing

Expand Down
Loading