You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-4Lines changed: 27 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,22 @@
1
1
## Ramen - A Terminal Interface for Ethereum 🍜
2
2
3
-
Ramen is a powerful terminal UI to interact with [Ethereum Network](https://ethereum.org/en/). It allows you to observe latest chain status, check account's balance and transaction history, navigate blocks and transactions, view smart contract's source code or call its functions, and many things more!
3
+
Ramen is a good-old terminal UI to interact with [Ethereum Network](https://ethereum.org/en/). It allows you to observe latest chain status, check account's balance and transaction history, navigate blocks and transactions, view smart contract's source code or call its functions, and many things more!
Additionally, Ramen is also well designed for smart contract development. Ramen can connect to a local chain (such as the one provided by Hardhat) to view transaction history of smart contract in development, call functions for testing, or verify its storage. Just works like Etherscan, but for your own chain!
8
14
9
15
## Installation
10
16
11
-
Currently Ramen is under active development and its interface, key-bindings, configurations are subject to change. As a result, you can install Ramen only by building from source at this time.
17
+
**Currently Ramen is under active development and its interface, key-bindings, configurations are subject to change.**
18
+
19
+
As a result, you can install Ramen only by building from source at this moment.
12
20
13
21
### Building From Source
14
22
@@ -35,7 +43,7 @@ To access Alchemy and Etherscan's service, you need an Api Key respectively. Ple
- [Etherscan: Getting an API key](https://docs.etherscan.io/getting-started/viewing-api-usage-statistics)
37
45
38
-
When the API keys are ready, you can create a configuration file `.ramen.json` in your home directory and place keys there.
46
+
When the API keys are ready, you can create a configuration file `.ramen.json` in your home directory (e.g. `~/.ramen.json`) and place keys there.
39
47
40
48
```json
41
49
{
@@ -53,6 +61,17 @@ Then you can launch Ramen now.
53
61
# connect to Goerli Testnet
54
62
./ramen --network "goerli"
55
63
```
64
+
65
+
### Key Bindings
66
+
67
+
Ramen inherits key bindings from underlying UI framework [tview](https://github.com/rivo/tview), the most frequently used keys are the following:
68
+
69
+
| Key | Action |
70
+
|---|---|
71
+
|`j`, `k`|Move cursor up and down|
72
+
|`enter`|Select an element|
73
+
|`tab`|Switch focus among elements|
74
+
56
75
### Connect Local Network
57
76
58
77
[Hardhat](https://hardhat.org/) / [Ganache](https://trufflesuite.com/ganache/) provides a local Ethereum network for development purpose. Ramen can be used as an user interface for these local networks.
@@ -61,6 +80,10 @@ Then you can launch Ramen now.
61
80
./ramen --provider "local"
62
81
```
63
82
83
+
## Contribution
84
+
85
+
Ramen is an open source project, any kind of contribution is welcome! Feel free to open issues for feature request, bug report or discussions.
86
+
64
87
## License
65
88
66
89
Ramen is released under the Apache 2.0 license. See LICENSE for details.
0 commit comments