Skip to content

Commit 5704c20

Browse files
committed
README: run make format-md
1 parent ac7d7e9 commit 5704c20

File tree

1 file changed

+25
-14
lines changed

1 file changed

+25
-14
lines changed

README.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,14 @@
77
width="152px">
88
</picture>
99

10-
![Beta][beta-badge] [![release-badge]][release-link] [![Changelog][changelog-badge]][changelog] [![Apache licensed]][Apache link]
10+
![Beta][beta-badge] [![release-badge]][release-link]
11+
[![Changelog][changelog-badge]][changelog] [![Apache licensed]][Apache link]
1112

12-
_The **Open Mina Node** is a fast and secure implementation of the Mina protocol in **Rust**._
13-
_Currently in **public beta**, join our [Discord community](https://discord.com/channels/484437221055922177/1290662938734231552) to help test future releases._
13+
_The **Open Mina Node** is a fast and secure implementation of the Mina protocol
14+
in **Rust**._
15+
_Currently in **public beta**, join our
16+
[Discord community](https://discord.com/channels/484437221055922177/1290662938734231552)
17+
to help test future releases._
1418

1519
</div>
1620

@@ -20,41 +24,48 @@ _Currently in **public beta**, join our [Discord community](https://discord.com/
2024

2125
### Building from Source
2226

23-
- [Rust Node](/docs/building-from-source-guide.md#how-to-build-and-launch-a-node-from-source) and [Dashboards](./docs/building-from-source-guide.md#how-to-launch-the-ui)
27+
- [Rust Node](/docs/building-from-source-guide.md#how-to-build-and-launch-a-node-from-source)
28+
and [Dashboards](./docs/building-from-source-guide.md#how-to-launch-the-ui)
2429
- [Web Node](/docs/local-webnode.md)
2530

2631
### Run Node on Devnet via Docker
2732

28-
- [Non-Block Producing Node](/docs/alpha-testing-guide.md) Connect to peers and sync a node on the devnet; no devnet stake needed.
29-
- [Block Producing Node](/docs/block-producer-guide.md) Produce blocks on the devnet; sufficient devnet stake needed.
30-
- [Local Block Production Demo](/docs/local-demo-guide.md) Produce blocks on a custom local chain without devnet stake.
31-
- [Devnet Archive Node](/docs/archive-node-guide.md) Run an archive node on devnet.
33+
- [Non-Block Producing Node](/docs/alpha-testing-guide.md) Connect to peers and
34+
sync a node on the devnet; no devnet stake needed.
35+
- [Block Producing Node](/docs/block-producer-guide.md) Produce blocks on the
36+
devnet; sufficient devnet stake needed.
37+
- [Local Block Production Demo](/docs/local-demo-guide.md) Produce blocks on a
38+
custom local chain without devnet stake.
39+
- [Devnet Archive Node](/docs/archive-node-guide.md) Run an archive node on
40+
devnet.
3241

3342
<img src="docs/assets/NodeUI.png" alt="Block production Node UI">
3443

3544
---
3645

3746
## Release Process
3847

39-
**This project is in beta**. We maintain a monthly release cycle, providing [updates every month](https://github.com/openmina/openmina/releases).
40-
41-
48+
**This project is in beta**. We maintain a monthly release cycle, providing
49+
[updates every month](https://github.com/openmina/openmina/releases).
4250

4351
## Core Features
4452

4553
- **Mina Network**: Connect to peers, sync up, broadcast messages
46-
- **Block Production**: Produces, validates, and applies blocks according to Mina's consensus.
54+
- **Block Production**: Produces, validates, and applies blocks according to
55+
Mina's consensus.
4756
- **SNARK Generation**: Produce SNARK proofs for transactions
4857
- **Debugging**: A block replayer that uses data from the archive nodes
4958

5059
## Repository Structure
5160

52-
- [core/](core) - Provides basic types needed to be shared across different components of the node.
61+
- [core/](core) - Provides basic types needed to be shared across different
62+
components of the node.
5363
- [ledger/](ledger) - Mina ledger implementation in Rust.
5464
- [snark/](snark) - Snark/Proof verification.
5565
- [p2p/](p2p) - P2p implementation for OpenMina node.
5666
- [node/](node) - Combines all the business logic of the node.
57-
- [native/](node/native) - OS specific pieces of the node, which is used to run the node natively (Linux/Mac/Windows).
67+
- [native/](node/native) - OS specific pieces of the node, which is used to
68+
run the node natively (Linux/Mac/Windows).
5869
- [testing/](node/testing) - Testing framework for OpenMina node.
5970
- [cli/](cli) - OpenMina cli.
6071
- [frontend/](frontend) - OpenMina frontend.

0 commit comments

Comments
 (0)