Skip to content

Commit c017764

Browse files
committed
Update the README
1 parent 2fb18fa commit c017764

1 file changed

Lines changed: 39 additions & 23 deletions

File tree

src/simple_safe/docs/README.md

Lines changed: 39 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,56 @@
22

33
A simple Web3-native CLI for Safe multisig wallets.
44

5-
Functionality:
5+
Main functionality:
66

7-
- `🚀` deploy a Safe account
7+
- `🚀` deploy a new Safe account
8+
- `🔍` inspect a Safe account
89
- `📝` build a Safe transaction
910
- `🔏` sign a Safe transaction
1011
- `🌐` execute a Safe transaction
1112
- `🔌` build and sign offline
1213
- `🪪` authenticate with a Trezor
1314
- `🪪` authenticate with a keyfile
1415

16+
Safe transaction types:
17+
18+
- `📐` custom transactions
19+
- `📡` smart contract call
20+
- `🪙` ERC-20 token call
21+
- `📦` batch transactions (via MultiSend)
22+
- `` contract deployment (via CreateCall)
23+
1524
Benefits:
1625

17-
- runs in the terminal
18-
- ✅ no Terms of Use to accept
19-
- ✅ no Privacy Policy to accept
20-
- ✅ all commands can be scripted
21-
- not reliant on centralized services
22-
- ✅ no need for chain to be officially supported
26+
- `💻` runs in the terminal
27+
- `🤖` all commands can be scripted
28+
- `` works with any EIP-1559 EVM chain
29+
- `🚫` does not collect your data
30+
- `🚫` does not impose any Terms of Use
31+
- `🚫` does not require centralized services
2332

2433
## Getting started
2534

26-
To get the most out of Simple Safe:
35+
👉 _To get the most out of Simple Safe, familiarize yourself with the
36+
[Safe Protocol](https://github.com/safe-global/safe-smart-account/blob/v1.4.1/docs/overview.md)
37+
summary and Safe's extensive
38+
[Safe Smart Accounts](https://docs.safe.global/advanced/smart-account-overview)
39+
documentation._
2740

28-
- familiarize yourself with the
29-
[Safe Protocol](https://github.com/safe-global/safe-smart-account/blob/v1.4.1/docs/overview.md)
30-
and
31-
[Safe Smart Accounts](https://docs.safe.global/advanced/smart-account-overview)
32-
documentation
41+
Before you get started, you will need:
3342

34-
To get started, you will need:
35-
36-
1. an EVM-compatible chain that supports EIP-1559
37-
2. a JSON-RPC endpoint over HTTP (not Websocket)
38-
3. the [Safe Smart Account](https://github.com/safe-global/safe-smart-account)
39-
contracts deployed (preferably at
40-
[canonical addresses](https://github.com/safe-global/safe-singleton-factory?tab=readme-ov-file#how-to-get-the-singleton-deployed-to-your-network))
43+
- Python 3.11 or later
44+
- the [pipx package manager](https://pipx.pypa.io/stable/installation/)
45+
- an EVM-compatible chain that supports EIP-1559
46+
- an Ethereum JSON-RPC endpoint over HTTP (not Websocket)
47+
- [Safe Smart Account](https://github.com/safe-global/safe-smart-account)
48+
contracts deployed (preferably at
49+
[canonical addresses](https://github.com/safe-global/safe-singleton-factory?tab=readme-ov-file#how-to-get-the-singleton-deployed-to-your-network))
4150

4251
Install Simple Safe using `pipx`:
4352

4453
```sh
45-
pipx install git+ssh://git@github.com/clearmatics/simple-safe.git
54+
pipx install simple-safe
4655
```
4756

4857
Upgrade Simple Safe to the latest version using `pipx`:
@@ -51,14 +60,21 @@ Upgrade Simple Safe to the latest version using `pipx`:
5160
pipx upgrade simple-safe
5261
```
5362

63+
⚠️ If upgrading from an earlier version installed from Github (pre-`0.3.0`),
64+
switch to PyPI releases with:
65+
66+
```sh
67+
pipx install --force simple-safe
68+
```
69+
5470
For convenience, set the environment variable `SAFE_RPC` to the JSON-RPC node
5571
URL:
5672

5773
```sh
5874
export SAFE_RPC=http://localhost:8545
5975
```
6076

61-
Use the `--help` option to explore the tool's subcommands:
77+
Use the `--help` option to explore Simple Safe commands:
6278

6379
```console
6480
$ safe --help

0 commit comments

Comments
 (0)