From 6ea877f04ade7a72a076fb10927931b60e8e4835 Mon Sep 17 00:00:00 2001 From: Robert Habermeier Date: Tue, 15 Jan 2019 16:30:38 -0300 Subject: [PATCH] add README --- cumulus/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 cumulus/README.md diff --git a/cumulus/README.md b/cumulus/README.md new file mode 100644 index 0000000000..0f87a8ba13 --- /dev/null +++ b/cumulus/README.md @@ -0,0 +1,19 @@ +# Cumulus + +A set of tools for writing [Polkadot](https://github.com/paritytech/polkadot) parachains that are based on [Substrate](https://github.com/paritytech/substrate). + +It's easy to write blockchains using Substrate, and the overhead of writing parachains' distribution, p2p, database, and synchronization layers is generally high and should be reusable. This project aims to make it easy to write parachains for Polkadot by leveraging the power of Substrate. + +Cumulus clouds are shaped sort of like dots and are up in the air, like this project (as it is an initial prototype -- expect a rename when it gets cooler.) + +## cumulus-consensus + +For now, this is only project contained in this repo. *cumulus-consensus* is a consensus engine for Substrate which follows a Polkadot relay chain. This will run a Polkadot node internally, and dictate to the client and synchronization algorithms which chain to follow, finalize, and treat as best. + +## cumulus-runtime + +A planned wrapper around substrate runtimes to turn them into parachain validation code and to provide proof-generation routines. + +## cumulus-collator + +A planned Polkadot collator for the parachain. \ No newline at end of file