Skip to content

Commit

Permalink
📚 Improve features section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
coccoinomane authored and Guido W. Pettinari committed Dec 16, 2022
1 parent 9b01327 commit 4b4e651
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 9 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
Interact with blockchains and smart contracts using the command line.
Interact with blockchains and smart contracts using the command line: no coding needed!

# Features

- Easily interact with EVM-compatible chains using your terminal
- Works with the most popular chains: Ethereum, Binance, Avalanche and more to come
- Save addresses you use often and access them with their tag
- Send transactions from multiple signers
- Interact with Ethereum-compatible chains via your terminal
- Bypass sluggish and potentially compromised frontends
- No configuration needed
- Label addresses, tokens and contracts for ease of use
- Use as many signers as you wish
- Concatenate commands to build powerful scripts
- [To be implemented]: Transfer tokens, using the token name (USDC, UNI, WETH, etc) instead of its address.
- [To be implemented]: DeFi support: sell Curve's rewards on Uniswap, setup a DCA plan on TraderJoe, etc.
- Thoroughly tested using [*brownie*](https://github.com/eth-brownie/brownie/)'s testing framework

Soon:

- Transfer tokens via their ticker
- Swap with Uniswap, TraderJoe, PancakeSwap, etc
- Claim and reinvest yield from DeFi protocols
- Set up scheduled buys and sells (DCA)
- Analys on-chain data for tax or sleuthing purposes


# Install
Expand Down Expand Up @@ -65,6 +73,7 @@ pip3 install -U web3cli

- Add RPCs to any existing chain:
```
w3 db rpc add eth https://eth-mainnet.g.alchemy.com/v2/{YOUR API KEY}
w3 db rpc add eth https://mainnet.infura.io/v3/{YOUR API KEY}
w3 db rpc add bnb https://bsc-dataseed.binance.org/
```
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "web3cli"
version = "0.11.0"
version = "0.11.1"
description = "Interact with blockchains and smart contracts using the command line"
authors = [
{name = "coccoinomane", email = "[email protected]"},
Expand Down
2 changes: 1 addition & 1 deletion src/web3cli/helpers/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from cement.utils.version import get_version_banner
from cement.utils.version import get_version as cement_get_version

VERSION = (0, 11, 0, "alpha", 0)
VERSION = (0, 11, 1, "alpha", 0)


def get_version_number(version: Tuple[int, int, int, str, int] = VERSION) -> str:
Expand Down

0 comments on commit 4b4e651

Please sign in to comment.