Skip to content

Commit

Permalink
docs: update readme (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
evilrobot-01 authored and chungquantin committed Jan 2, 2025
1 parent 458afa2 commit 44f4ab9
Showing 1 changed file with 9 additions and 63 deletions.
72 changes: 9 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,17 @@
<div align="center">
# Assets Parachain Template

# Base Parachain Template
A new [Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus)-based Substrate node, configured with fungible and non-fungilble asset functionalities, including asset fractionalization.

<img height="70px" alt="Polkadot SDK Logo" src="https://github.com/paritytech/polkadot-sdk/raw/master/docs/images/Polkadot_Logo_Horizontal_Pink_White.png#gh-dark-mode-only"/>
<img height="70px" alt="Polkadot SDK Logo" src="https://github.com/paritytech/polkadot-sdk/raw/master/docs/images/Polkadot_Logo_Horizontal_Pink_Black.png#gh-light-mode-only"/>
<br /><br />
<a href="r0gue.io"><img src="https://github.com/user-attachments/assets/96830651-c3db-412a-9cb4-6fcd8ea6231b" alt="R0GUE Logo" /></a>
This project is a fork of the [Base Parachain Template](https://github.com/r0gue-io/base-parachain).

[![Twitter URL](https://img.shields.io/twitter/follow/Pop?style=social)](https://x.com/onpopio/)
[![Twitter URL](https://img.shields.io/twitter/follow/R0GUE?style=social)](https://twitter.com/gor0gue)
[![Telegram](https://img.shields.io/badge/Telegram-gray?logo=telegram)](https://t.me/onpopio)
It is used to generate parachains using [Pop CLI](https://github.com/r0gue-io/pop-cli), an all-in-one tool for Polkadot development.

> This template is used to generate parachains using [Pop CLI](https://github.com/r0gue-io/pop-cli) - an all-in-one tool for Polkadot development.
## Next Steps

> It is based on the [Polkadot SDK](https://github.com/paritytech/polkadot-sdk) and is updated by [R0GUE](r0gue.io) after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
💥 Learn more about Pop CLI [here](https://learn.onpop.io/pop/v/pop-cli).

</div>
🚀 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).

* ⏫ This template provides a starting point to build a [parachain](https://wiki.polkadot.network/docs/learn-parachains).

* ☁️ It is based on the
[Cumulus](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/cumulus/index.html) framework.

* 🔧 Its runtime is configured with a single custom pallet as a starting point, and a handful of ready-made pallets
such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).

## Template Structure

A Polkadot SDK based project such as this one consists of:

* 💿 [Node](./node/README.md) - the binary application.
* 🧮 [Runtime](./runtime/README.md) - the core logic of the parachain.

## Getting Started

#### Install [Pop CLI](https://github.com/r0gue-io/pop-cli) - the all-in-one Polkadot development tool:
> Detailed installation instructions can be found [here](https://learn.onpop.io/v/cli/installing-pop-cli).
```
cargo install --force --locked pop-cli
```

#### Start a new parachain project with this template:
```
pop new parachain
```

#### Learn how to run your parachain using the `pop up` command:
```sh
pop up parachain -f ./network.toml
```
> 👉 https://learn.onpop.io/v/appchains/guides/running-your-parachain
### Learning Resources

* 🧑‍🏫 To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point.

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

* 🧑‍🔧 For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are
the Polkadot SDK documentation resources.

* 📖 To learn how to develop parachains with Pop CLI, read the [guides](https://learn.onpop.io/v/appchains).

### Support

* 💡 Be part of our passionate community of Web3 pioneers. [Join our Telegram](https://t.me/onpopio)!

* 👥 Additionally, there are [GitHub issues](https://github.com/r0gue-io/base-parachain/issues) and
[Polkadot Stack Exchange](https://polkadot.stackexchange.com/).
👉 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/).

0 comments on commit 44f4ab9

Please sign in to comment.