Skip to content

Commit 41c6fe4

Browse files
Minor improvements
1 parent 1f21693 commit 41c6fe4

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

+17-18
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Nomos
22

3-
Nomos is the blockchain layer of the Logos technology stack.
4-
5-
This monorepo is a unified codebase for the Nomos ecosystem, providing a privacy-preserving and censorship-resistant
3+
Nomos is the blockchain layer of the Logos technology stack, providing a privacy-preserving and censorship-resistant
64
framework for decentralized network states.
75

8-
It houses all core components, services, and tools necessary for running and interacting with the Nomos blockchain,
9-
including:
6+
This monorepo serves as a unified codebase for the Nomos ecosystem, housing all core components, services, and tools
7+
necessary for running and interacting with the Nomos blockchain. Key features include:
108

119
- Consensus mechanisms for secure and scalable network agreement
1210
- Ledger management for state persistence and validation
@@ -18,6 +16,8 @@ including:
1816

1917
- [Requirements](#requirements)
2018
- [Design Goals](#design-goals)
19+
- [Service Architecture](#service-architecture)
20+
- [Static Dispatching](#static-dispatching)
2121
- [Project Structure](#project-structure)
2222
- [Development Workflow](#development-workflow)
2323
- [Docker](#docker)
@@ -29,25 +29,24 @@ including:
2929

3030
## Requirements
3131

32-
**Rust**
33-
34-
- We aim to maintain compatibility with the latest stable version of Rust.
35-
- [Installation Guide](https://www.rust-lang.org/tools/install)
32+
- **Rust**
33+
- We aim to maintain compatibility with the latest stable version of Rust.
34+
- [Installation Guide](https://www.rust-lang.org/tools/install)
3635

37-
**Risc0**
38-
39-
- Required for zero-knowledge proof functionality.
40-
- [Installation Guide](https://dev.risczero.com/api/zkvm/install)
36+
- **Risc0**
37+
- Required for zero-knowledge proof functionality.
38+
- [Installation Guide](https://dev.risczero.com/api/zkvm/install)
4139

4240
## Design Goals
4341

4442
### Service Architecture
4543

46-
Most of Nomos' services are implemented with the same idea behind:
47-
There is a front layer responsible for handling the `Overwatch` service and a back layer that implements
48-
the actual service logic.
44+
Nomos services follow a consistent design pattern: a front layer handles the `Overwatch` service, while a back layer
45+
implements the actual service logic.
46+
47+
This modular approach allows for easy replacement of components in a declarative manner.
4948

50-
This enables us to easily replace services' components in a declarative manner. For example:
49+
For example:
5150

5251
```rust ignore
5352
#[derive(Services)]
@@ -62,7 +61,7 @@ struct MockPoolNode {
6261

6362
### Static Dispatching
6463

65-
Nomos leans toward static dispatching over dynamic, partly influenced by `Overwatch`.
64+
Nomos favours static dispatching over dynamic, influenced by Overwatch.
6665
This means you'll encounter Generics sprinkled throughout the codebase.
6766
While it might occasionally feel a bit over the top, it brings some solid advantages, such as:
6867

0 commit comments

Comments
 (0)