Skip to content

Commit

Permalink
Adds introduction to README. (#856)
Browse files Browse the repository at this point in the history
Feel free to ignore this PR if you (the repo mainainers) think it isn't necessary.

This PR takes the introduction paragraph from the Moonbeam docs and places it at the head of this repo's README.

---

I found this repo from a link in a group chat, but struggled to figure out what this repo was actually for. The text "Create parallel reality of your Substrate network" didn't clear anything up. 

After a bit of searching I found the Moonbeam docs with a page detailing how to use Chopsticks with Moonbeam: https://docs.moonbeam.network/builders/substrate/dev-env/chopsticks/. I figured that intro would work well here too.
  • Loading branch information
johnnymatthews authored Nov 14, 2024
1 parent 4a0899c commit 8a286d1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@

Create parallel reality of your Substrate network.

## Introduction

Chopsticks provides a developer-friendly method of locally forking existing Substrate based chains. It allows for the replaying of blocks to easily examine how extrinsics effect state, the forking of multiple blocks for XCM testing, and more. This allows developers to test and experiment with their own custom blockchain configurations in a local development environment, without the need to deploy a live network. Chopsticks aims to simplify the process of building blockchain applications on Substrate and make it accessible to a wider range of developers.

## Quick Start

Fork Acala mainnet: `npx @acala-network/chopsticks@latest --endpoint=wss://acala-rpc-2.aca-api.network/ws`
Expand Down

0 comments on commit 8a286d1

Please sign in to comment.