Skip to content

Commit 5a5420b

Browse files
committed
add changelog, prepare v0.0.2
1 parent fd97277 commit 5a5420b

File tree

3 files changed

+34
-15
lines changed

3 files changed

+34
-15
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Change Log
2+
All notable changes will be documented in this file.
3+
4+
5+
## v0.0.1 - 0.0.2
6+
7+
- first alpha

README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@ An interactive Solidity shell with lightweight session recording.
2323
352
2424
» $_
2525
352
26-
» msg.sender
27-
0x70e9B09abd6A13D2F5083CD5814076b77427199F
28-
» address(uint160(address(msg.sender)))
29-
0x70e9B09abd6A13D2F5083CD5814076b77427199F
3026
```
3127

3228
### Hints
@@ -48,36 +44,55 @@ An interactive Solidity shell with lightweight session recording.
4844
#### Sample Usage
4945

5046
```shell
47+
48+
🚀 Entering interactive Solidity shell. .help and .exit are your friends.
49+
50+
» ℹ️ ganache-mgr: starting temp. ganache instance ...
51+
»
5152
» .help
5253

5354
📚 Help:
5455
-----
5556

56-
General:
57+
$_ is a placeholder holding the most recent evaluation result.
58+
59+
60+
General:
5761
.help ... this help :)
5862
.exit ... exit the shell
5963

60-
Settings:
64+
Settings:
6165
.config ... show settings
6266
set <key> <value> ... set setting
6367
unset <key> ... unset setting
64-
Session:
68+
Session:
6569
.session ... list sessions
6670
load <id> ... load session
6771
save <id> ... save session
6872

6973
.undo ... undo last command
7074
.reset ... reset cmd history. start from scratch.
7175

72-
Debug:
73-
.dump ... (debug) show template contract
76+
Debug::
77+
.proc ... show processes managed by solidity-shell (ganache)
78+
.dump ... show template contract
79+
.echo ... every shell needs an echo command
7480

7581

7682
cheers 🙌
7783
@tintinweb
78-
ConsenSys Diligence @ https://diligence.consensys.net/
84+
ConsenSys Diligence @ https://consensys.net/diligence/
85+
https://github.com/tintinweb/solidity-shell/
7986
```
8087

88+
#### Transaction vars: `msg.sender` etc.
89+
90+
```javascript
91+
» msg.sender
92+
0x70e9B09abd6A13D2F5083CD5814076b77427199F
93+
» address(uint160(address(msg.sender)))
94+
0x70e9B09abd6A13D2F5083CD5814076b77427199F
95+
```
8196

8297
#### Contracts, Structs, Functions
8398

@@ -106,7 +121,7 @@ multi> }
106121

107122
#### Advanced usage
108123

109-
```
124+
```javascript
110125
» struct yolo {uint8 x; uint8 y;}
111126
» .dump
112127
// SPDX-License-Identifier: GPL-2.0-or-later
@@ -134,9 +149,6 @@ contract MainContract {
134149
____
135150

136151

137-
138-
____
139-
140152
## Acknowledgements
141153

142154
* Inspired by the great but unfortunately unmaintained [solidity-repl](https://github.com/raineorshine/solidity-repl).

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "solidity-shell",
3-
"version": "0.0.1",
3+
"version": "0.0.2",
44
"description": "",
55
"main": "src/index.js",
66
"bin": {

0 commit comments

Comments
 (0)