Skip to content

docs: improve Usage section in README #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TetrisIsCute wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve Usage section in README #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,12 @@ Browser wallets(Metamask, Coinbase Wallet, etc) use Safes on the backend


### Usage
Populate your .env file based on .env.example.

Run examples using ts-node:
```bash
Populate your `.env` file based on `.env.example`.

Run examples using `ts-node` from the repository root, for example:
Safe wallet example
ts-node examples/safeWallet/split.ts
```

Proxy wallet example
ts-node examples/proxyWallet/redeem.ts