Skip to content

Commit cd026ad

Browse files
committed
Update README and include screenshots
1 parent d1786ef commit cd026ad

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
## Ramen - A Terminal Interface for Ethereum 🍜
22

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!
44

5-
(screenshots here)
5+
1. View account balance, transactions etc.
6+
7+
<img src="https://user-images.githubusercontent.com/1492050/215658150-93b09da7-52b2-4366-ba24-4a56668cf2a8.png"/>
8+
9+
2. Call contract's function
10+
11+
<img src="https://user-images.githubusercontent.com/1492050/215658167-b38bcf0b-8dd4-4b95-8198-5411fe3fd7e0.png"/>
612

713
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!
814

915
## Installation
1016

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.
1220

1321
### Building From Source
1422

@@ -35,7 +43,7 @@ To access Alchemy and Etherscan's service, you need an Api Key respectively. Ple
3543
- [Alchemy Quickstart Guide](https://docs.alchemy.com/lang-zh/docs/alchemy-quickstart-guide)
3644
- [Etherscan: Getting an API key](https://docs.etherscan.io/getting-started/viewing-api-usage-statistics)
3745
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.
3947
4048
```json
4149
{
@@ -53,6 +61,17 @@ Then you can launch Ramen now.
5361
# connect to Goerli Testnet
5462
./ramen --network "goerli"
5563
```
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+
5675
### Connect Local Network
5776
5877
[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.
6180
./ramen --provider "local"
6281
```
6382
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+
6487
## License
6588
6689
Ramen is released under the Apache 2.0 license. See LICENSE for details.

0 commit comments

Comments
 (0)