Skip to content

Commit 78bc987

Browse files
authored
Update README.md
1 parent a1fdefc commit 78bc987

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,13 @@
66

77
## Solidity Shell
88

9-
An interactive Solidity shell with lightweight session recording.
9+
An interactive Solidity shell with lightweight session recording and remote compiler support.
1010

1111
[💾](https://www.npmjs.com/package/solidity-shell) `npm install solidity-shell`
1212

13-
<sub><b>note:</b> may require `npm install ganache-cli` if option `autostartGanache=True` (default)
13+
<sub><b>note:</b> may require `npm install ganache-cli` unless it is already installed :)
1414
</sub>
1515

16-
1716
```javascript
1817
⇒ solidity-shell
1918

@@ -28,17 +27,19 @@ An interactive Solidity shell with lightweight session recording.
2827
352
2928
```
3029

30+
Oh, did you know that we automatically fetch a matching remote compiler when you change the solidity pragma? It is as easy as typing `pgrama solidity 0.5.0` and solidity-shell will do the rest 🙌
31+
3132
### Hints
3233

3334

34-
* **Note**: Type `pragma solidity <version>` to dynamically load a different compiler version.
35-
* **Note**: Sessions can be saved and restored using the `.session` command. Your previous session is always stored and can be loaded via `.session load previous` (not safe when running concurrent shells).
36-
* **Note**: `.reset` completely removes all statements. `.undo` removes the last statement.
37-
* **Note**: See what's been generated under the hood? call `.dump`.
38-
* **Note**: Settings are saved on exit (not safe when running concurrent shells). call `config set <key> <value>` to change settings like ganache port, ganache autostart, etc.
39-
* **Note**: Solidity version is currently fixed to the `solc` package that comes with the shell. If there's interest we might change that to allow remote compiler versions.
40-
* **Note**: `$_` is a placeholder for the last known result. Feel free to use that placeholder in your scripts :)
41-
* **Note**: Special commands are dot-prefixed. Everything else is evaluated as Solidity code.
35+
36+
* `pragma solidity <version>` attempts to dynamically load the selected compiler version (remote compiler, may take a couple of seconds).
37+
* Sessions can be saved and restored using the `.session` command. Your previous session is always stored and can be loaded via `.session load previous` (not safe when running concurrent shells).
38+
* `.reset` completely removes all statements. `.undo` removes the last statement.
39+
* See what's been generated under the hood? call `.dump`.
40+
* Settings are saved on exit (not safe when running concurrent shells). call `config set <key> <value>` to change settings like ganache port, ganache autostart, etc.
41+
* `$_` is a placeholder for the last known result. Feel free to use that placeholder in your scripts :)
42+
* Special commands are dot-prefixed. Everything else is evaluated as Solidity code.
4243

4344
### Usage
4445

0 commit comments

Comments
 (0)