Skip to content

Commit 92172bd

Browse files
committed
chore: update README
1 parent ad1cb70 commit 92172bd

1 file changed

Lines changed: 33 additions & 9 deletions

File tree

README.md

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ Head to [BFTE's Radicle site][bfte-radicle] for an up to date version.
1313

1414
## Introduction
1515

16-
It's fair to say BFTE in its current form is a research on alternative
17-
implementation of a Fedimint-like system, and this project aims at the very similar *very-long*
18-
term goals as [Fedimint][fedimint], but having benefit of years of extra experience, and allowing
19-
focus on parts and goals that the author (dpc) finds most promising and interesting.
16+
BFTE in its current form is a research project on alternative
17+
design/implementation of a Fedimint-like system. While th *very-long*
18+
term goals and supported use-cases could be similar to [Fedimint][fedimint],
19+
it has a luxury of not worrying about immediate practical application,
20+
and enabling focus on parts and goals that the author (dpc)
21+
finds most promising and interesting.
2022

2123
[fedimint]: http://github.com/fedimint/fedimint
2224

@@ -25,23 +27,25 @@ where it seems to make sense.
2527

2628
Fedimint started as a Bitcoin Ecash Mint solution, with a side-goal/need
2729
of building a general purpose consensus engine. BFTE stars with
28-
a goal of being a good general purpose consensus engine first, with an ability
29-
to support Bitcoin/cryptography applications like Ecash Mints "maybe one
30+
a goal of researching a good general purpose consensus engine first, with
31+
an ability to support Bitcoin/cryptography applications like Ecash Mints "maybe one
3032
day".
3133

32-
Things like Bitcoin and Lightning Network support are a huge time sinks,
33-
with large and complex integrations and ever evolving ecosystem, with a huge
34+
Things like Bitcoin and Lightning Network support are a big and difficult tasks
35+
in itself, with large and complex integrations and ever evolving ecosystem, with a huge
3436
expectations on stability and robustness.
3537

3638
BFTE can just let Fedimint chart these difficult waters, while only
3739
worrying about the general architecture eventually be able to support
38-
what Fedimint can already do, while focusing on less mission-critical things,
40+
what Fedimint can already do, while focusing on less mission-critical applications,
3941
like:
4042

4143
* CI system coordination,
4244
* review systems,
4345
* etc.
4446

47+
Basically - things that could benefit from a BFT Consensus.
48+
4549
Similarly, Fedimint's ambition was always reaching broad end user appeal.
4650
This requires a lot of effort: building end user clients including web and
4751
mobile apps, cross-platform support, interoperability, API stability, backward
@@ -51,6 +55,26 @@ By ignoring all these ambitions, BFTE can focus first on honing the primary
5155
goal: becoming good general purpose modular consensus engine, and be ambitious
5256
about other aspects of the design places and implementation.
5357

58+
## Status
59+
60+
As of last update the project has most of the core pieces in a working state:
61+
62+
* Simplex Consensu algorithm is implemented,
63+
* has a usable web UI,
64+
* Consensus Control Mode allows adding and removing peers from the consensus,
65+
* Metadata Module is a first simple showcase module.
66+
67+
## Running
68+
69+
BFTE is a standard Rust application. You can clone it and use `cargo` to build
70+
and run it. Using the provided Nix Flake Dev Shell is recommend.
71+
72+
If you're a Nix user (which you should be), you can easily give it a try:
73+
74+
```
75+
nix run git+https://radicle.dpc.pw/zii8qFzZhN3vigh8BuxGCuEEp6z4.git
76+
```
77+
5478
## Links
5579

5680
* [BFTE Radicle site][bfte-radicle]

0 commit comments

Comments
 (0)