Skip to content

Commit dcfbaad

Browse files
Minor improvements
1 parent ae0f629 commit dcfbaad

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

README.md

+17-19
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
@@ -17,8 +15,9 @@ including:
1715
## Table of Contents
1816

1917
- [Requirements](#requirements)
20-
- [Features](#features)
2118
- [Design Goals](#design-goals)
19+
- [Service Architecture](#service-architecture)
20+
- [Static Dispatching](#static-dispatching)
2221
- [Project Structure](#project-structure)
2322
- [Development Workflow](#development-workflow)
2423
- [Docker](#docker)
@@ -30,25 +29,24 @@ including:
3029

3130
## Requirements
3231

33-
**Rust**
34-
35-
- We aim to maintain compatibility with the latest stable version of Rust.
36-
- [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)
3735

38-
**Risc0**
39-
40-
- Required for zero-knowledge proof functionality.
41-
- [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)
4239

4340
## Design Goals
4441

4542
### Service Architecture
4643

47-
Most of Nomos' services are implemented with the same idea behind:
48-
There is a front layer responsible for handling the `Overwatch` service and a back layer that implements
49-
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.
5048

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

5351
```rust ignore
5452
#[derive(Services)]
@@ -63,7 +61,7 @@ struct MockPoolNode {
6361

6462
### Static Dispatching
6563

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

0 commit comments

Comments
 (0)