-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: update readme * docs: improve readme
- Loading branch information
1 parent
7204f16
commit 3eb5697
Showing
1 changed file
with
12 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,18 @@ | ||
# Substrate Cumulus Parachain Template | ||
# Base Parachain Template | ||
|
||
A new [Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus)-based Substrate node, ready for hacking ☁️.. | ||
A new [Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus)-based Substrate node. | ||
|
||
This project is originally a fork of the | ||
[Substrate Node Template](https://github.com/substrate-developer-hub/substrate-node-template) | ||
modified to include dependencies required for registering this node as a **parathread** or | ||
**parachain** to a **relay chain**. | ||
This project is a fork of the | ||
[Cumulus Parachain Template](https://github.com/paritytech/polkadot-sdk/tree/master/templates/parachain) from the [Polkadot SDK](https://github.com/paritytech/polkadot-sdk). | ||
|
||
The stand-alone version of this template is hosted on the | ||
[Substrate Devhub Parachain Template](https://github.com/substrate-developer-hub/substrate-parachain-template/) | ||
for each release of Polkadot. It is generated directly to the upstream | ||
[Parachain Template in Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus/parachain-template) | ||
at each release branch using the | ||
[Substrate Template Generator](https://github.com/paritytech/substrate-template-generator/). | ||
It is used to generate parachains using [Pop CLI](https://github.com/r0gue-io/pop-cli), an all-in-one tool for Polkadot development. | ||
|
||
👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains), and | ||
parathreads [here](https://wiki.polkadot.network/docs/learn-parathreads). | ||
## Next Steps | ||
|
||
💥 Learn more about Pop CLI [here](https://learn.onpop.io/pop/v/pop-cli). | ||
|
||
🧙 Learn about how to use this template and run your own parachain testnet for it in the | ||
[Devhub Cumulus Tutorial](https://docs.substrate.io/tutorials/v3/cumulus/start-relay/). | ||
🚀 Learn about how to run your own parachain testnet using Pop CLI [here](https://learn.onpop.io/pop/v/pop-cli/parachains/running-your-parachain). | ||
|
||
👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains). | ||
|
||
🧙 Learn about how to build using this template [here](https://docs.substrate.io/tutorials/). |