From 829c495ed0945e8ca2c1bec0b0f265763c62d051 Mon Sep 17 00:00:00 2001 From: Santiago Carmuega Date: Fri, 26 Nov 2021 23:09:26 -0300 Subject: [PATCH] Try out readme TOC --- README.md | 12 ++++++++++++ pallas-multiplexer/README.md | 2 ++ 2 files changed, 14 insertions(+) create mode 100644 pallas-multiplexer/README.md diff --git a/README.md b/README.md index 4bc3496..ab70866 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,18 @@ application, it is meant to be used as a base layer to facilitate the development of higher-level use-cases, such as explorers, wallets, etc (who knows, maybe even a full node in the far away future). +## Unboxing +| Crates | Description | +|---------------------|----------------------------------------------------------------------------------| +| [pallas-machines](/pallas-machines) | A framework for implementing state machines for Ouroboros network mini-protocols | +| [pallas-multiplexer](/pallas-multiplexer) | A multithreaded Ouroboros multiplexer implementation using mpsc channels | +| [pallas-handshake](/pallas-handshake) | An implementation of the Ouroboros network handshake mini-protocol | +| [pallas-blockfetch](/pallas-blockfetch) | An implementation of the Ouroboros network blockfetch mini-protocol | +| [pallas-chainsync](/pallas-chainsync) | An implementation of the Ouroboros network chainsync mini-protocol | +| [pallas-txsubmission](/pallas-txsubmission) | An implementation of the Ouroboros network txsubmission mini-protocol | +| [pallas-alonzo](/pallas-alonzo) | Ledger primitives and cbor codec for the Alonzo era | +| pallas | An all-in-one crate that re-exports the other ones in an ordered fashion | + ## Etymology > Pallas: (Greek mythology) goddess of wisdom and useful arts and prudent warfare; diff --git a/pallas-multiplexer/README.md b/pallas-multiplexer/README.md new file mode 100644 index 0000000..6d88c25 --- /dev/null +++ b/pallas-multiplexer/README.md @@ -0,0 +1,2 @@ +# Pallas Multiplexer +