Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

README for template updated #1980

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

README for template updated #1980

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f5032d4
README for template updated
nuke-web3 Dec 12, 2022
99c1ec3
Update README.md
nuke-web3 Dec 12, 2022
1ba6705
Update parachain-template/README.md
nuke-web3 Dec 12, 2022
2908a27
Update parachain-template/README.md
May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 8 additions & 15 deletions parachain-template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,15 @@
# Substrate Cumulus Parachain Template
# Substrate Parachain Template

A new [Cumulus](https://github.com/paritytech/cumulus/)-based Substrate node, ready for hacking ☁️..
A new [Cumulus](https://github.com/paritytech/cumulus/)-based Parachain node, ready for hacking 🚀

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**.

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/cumulus/tree/master/parachain-template)
at each release branch using the
[Substrate Template Generator](https://github.com/paritytech/substrate-template-generator/).
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.
This is generated directly at each `polkadot-vX.X.X` release branch from the [Parachain Template in Cumulus](https://github.com/paritytech/cumulus/tree/master/parachain-template) upstream.

👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains), and
parathreads [here](https://wiki.polkadot.network/docs/learn-parathreads).
It is usually best to to use the stand-alone version to start a new project.
All bugs, suggestions, and feature requests should be made upstream to [Cumulus](https://github.com/paritytech/cumulus/tree/master/parachain-template).

👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains).

🧙 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/).
[Build a Parachain tutorials](https://docs.substrate.io/tutorials/build-a-parachain/).