Skip to content

Commit

Permalink
update: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
anshalshukla committed Jan 7, 2024
1 parent cb7efe6 commit 93b35c4
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# Madara CLI

A CLI tool to quickly deploy Madara app chains.
A command-line tool for rapid deployment of Madara app chains.

## Dependencies

1. [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
2. [Rust](https://doc.rust-lang.org/book/ch01-01-installation.html)
3. [Docker](https://docs.docker.com/desktop/)

## Quick Start

1. Clone the `madara-cli` repo:
```shell
$ git clone https://github.com/karnotxyz/madara-cli
```

2. Navigate to the madara-cli directory and build the tool:
```shell
$ cd madara-cli
$ cargo build --release
```

3. Initialize a new app chain. Ensure to fund the logged account, especially if you've chosen Avail as your DA Layer.
```shell
$ ./target/release/madara-cli init
```
4. Run your app chain:
```shell
$ ./target/release/madara-cli run
```
5. Optionally, explore the StarkScan explorer. Accessible at http://localhost:4000.
```shell
$ ./target/release/madara-cli explorer
```
Congratulations! You now have a custom madara app running.

0 comments on commit 93b35c4

Please sign in to comment.