Skip to content

Commit

Permalink
READM: fix diagram alignment
Browse files Browse the repository at this point in the history
  • Loading branch information
karalabe committed Jul 9, 2024
1 parent 50bbc70 commit abc6648
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ There are several possible outcomes from this experiment:

## Design

The `ssz` package splits the responsibility between user code and library code in the way charted below:
The `ssz` package splits the responsibility between user code and library code in the way pictured below:

![Scope](./docs/scope.svg)

Expand All @@ -38,6 +38,10 @@ The `ssz` package splits the responsibility between user code and library code i
- Similarly to the *SSZ Vector* and *SSZ List* types, the *SSZ Basic Types* are constructed inside the library from user supplied Go primitive types, or within Go arrays and slices. The caller is not able to create their own Go types that serialize into a standalone *SSZ Basic Type*.
- *SSZ Union* is not implemented as it is an unused (and disliked) feature in Ethereum.

### Weird shit

The [SSZ spec](https://github.com/ethereum/consensus-specs/blob/dev/ssz/simple-serialize.md) has schema definitions for mapping SSZ data to [JSON and YAML](https://github.com/ethereum/consensus-specs/blob/dev/ssz/simple-serialize.md#json-mapping). We believe in separation of concerns. This library does not (nor will ever) concern itself with encoding/decoding from formats other than SSZ.

## How to use

First up, you need to add the package to your project:
Expand Down
Loading

0 comments on commit abc6648

Please sign in to comment.