Skip to content

Commit 3d4a3d7

Browse files
authored
Add build step by step guide, tweak tagline (#20)
1 parent 5a213bb commit 3d4a3d7

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="https://github.com/dethcrypto/ethereum-code-viewer/blob/main/docs/logo.png?raw=true" width="300" alt="ethereum code viewer">
33
<h3 align="center">Ethereum Code Viewer</h3>
44
<p align="center">View source of deployed Ethereum smart contracts in VS Code</p>
5-
<p align="center">Comfortably browse contracts verified on etherscan</p>
5+
<p align="center">While on Etherscan, change <code>.io</code> to <code>.deth.net</code> and browse contracts comfortably in ephemeral VS Code instance</p>
66

77
<p align="center">
88
<a href="https://github.com/dethcrypto/ethereum-code-viewer/actions"><img alt="Build Status" src="https://github.com/dethcrypto/ethereum-code-viewer/actions/workflows/ci.yml/badge.svg"></a>
@@ -16,7 +16,7 @@
1616

1717
## Usage
1818

19-
While browsing smart contract code on [Etherscan](https://etherscan.io/) just change URL from `.io` to `deth.net`. This will open Visual Studio Code instance and fetch the verified code using Etherscan API.
19+
While browsing smart contract code on [Etherscan](https://etherscan.io/) just change URL from `.io` to `.deth.net`. This will open Visual Studio Code instance and fetch the verified code using Etherscan API.
2020

2121
![ecv](https://user-images.githubusercontent.com/1814312/146108385-6fa50ae7-14a5-45b2-be3d-201d22409cf7.gif)
2222

@@ -47,12 +47,25 @@ The repository contains two packages, `ethereum-viewer` extension and the VSCode
4747
All packages (currently one) except of `@dethcrypto/ethereum-viewer-vscode-host` located in `packages/vscode-host` are managed by `pnpm`.
4848
As VSCode depends on Yarn, our `vscode-host` also needs Yarn.
4949

50-
You need to create dummy certs using [`mkcert`](https://github.com/FiloSottile/mkcert):
50+
### Step by step instructions
5151

5252
```sh
53+
# You need to create dummy certs using mkcert - https://github.com/FiloSottile/mkcert
5354
cd ./certs
5455
mkcert localhost
5556
mkcert -install
57+
cd ..
58+
59+
# install deps
60+
pnpm install
61+
62+
# install vscode deps
63+
cd packages/vscode-host/
64+
yarn
65+
cd ../../
66+
67+
yarn build # this builds whole vscode and can take A LOT of time
68+
yarn serve
5669
```
5770

5871
### Scripts

0 commit comments

Comments
 (0)