Skip to content

Commit 41e3f67

Browse files
Merge pull request #1199 from dfinity/jessiemongeon1-patch-30
Standardize README
2 parents 0773968 + 05c937e commit 41e3f67

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

rust/evm_block_explorer/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,27 @@
33
The EVM Block Explorer example demonstrates how an ICP smart contract can obtain information directly from other blockchain networks. Using HTTPS outcalls, smart contracts on ICP can interact with other networks without needing to go through a third-party service such as a bridge or an oracle. Supported interactions with other chains include querying network data, signing transactions, and submitting transactions directly to other networks.
44
In this example, you'll also see how to sign transactions with canister ECDSA or Schnorr signatures.
55

6-
This application's logic is written in [Rust](https://internetcomputer.org/docs/building-apps/developer-tools/cdks/rust/intro-to-rust), a primary programming language for developing canisters on ICP.
7-
86
## Deploying from ICP Ninja
97

108
When viewing this project in ICP Ninja, you can deploy it directly to the mainnet for free by clicking "Deploy" in the upper right corner. Open this project in ICP Ninja:
119

1210
[![](https://icp.ninja/assets/open.svg)](https://icp.ninja/i?g=https://github.com/dfinity/examples/rust/evm_block_explorer)
1311

14-
## Project structure
12+
## Build and deploy from the command-line
13+
14+
### 1. [Download and install the IC SDK.](https://internetcomputer.org/docs/building-apps/getting-started/install)
1515

16-
The `/backend` folder contains the Rust smart contract:
16+
### 2. Download your project from ICP Ninja using the 'Download files' button on the upper left corner, or [clone the GitHub examples repository.](https://github.com/dfinity/examples/)
1717

18-
- `Cargo.toml`, which defines the crate that will form the backend
19-
- `lib.rs`, which contains the actual smart contract, and exports its interface
18+
### 3. Navigate into the project's directory.
2019

21-
The `/frontend` folder contains web assets for the application's user interface. The user interface is written using the React framework.
20+
### 4. Deploy the project to your local environment:
2221

23-
## Build and deploy from the command-line
22+
```
23+
dfx start --background --clean && dfx deploy
24+
```
2425

25-
To migrate your ICP Ninja project off of the web browser and develop it locally, follow these steps. These steps are necessary if you want to deploy this project for long-term, production use on the mainnet.
26+
## Security considerations and best practices
2627

27-
### 1. Download your project from ICP Ninja using the 'Download files' button on the upper left corner under the pink ninja star icon.
28+
If you base your application on this example, it is recommended that you familiarize yourself with and adhere to the [security best practices](https://internetcomputer.org/docs/building-apps/security/overview) for developing on ICP. This example may not implement all the best practices.
2829

29-
### 2. Open the `BUILD.md` file for further instructions.

0 commit comments

Comments
 (0)