Skip to content

Commit

Permalink
docs: update readme and config example
Browse files Browse the repository at this point in the history
  • Loading branch information
will7200 committed Apr 19, 2021
1 parent e244387 commit f8a1bda
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

# Crypto Sync

Sync your Cryptocurrency to a Personal Capital Account
Sync your Cryptocurrency Holdings to a Personal Capital Account

## Supported Cryptocurrency Holdings

1. Coinbase
2. Ethereum via etherscan
2. Ethereum and derivatives via etherscan
3. Coinbase Pro
4. Binance Coin and derivatives via bscscan

## Example Commands

Expand Down Expand Up @@ -41,6 +43,25 @@ contractAddress = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
symbolName = "USDC"
fullName = "USD Coin"
decimals = 6
[holdings.coinbasepro]
debug = true
[[holdings.coinbasepro.portfolios]]
name = "default_portfolio"
secret = "some_secret"
key = "some_key"
passphrase = "some_pass_phrase"
# If base_url is left blank with default to the value below
base_url = "https://api.pro.coinbase.com"
[holdings.bscscan]
apiKey = "some-api-key"
debug = false
# If base_url is defaulted to the below url
# base_url = "https://api.bscscan.com/api?"
[[holdings.bscscan.account]]
address = "0xaddress"
symbolName = "BNB"
fullName = "Binance Coin"
decimals = 18
[destinations]
[destinations.personalcapital]
email = "example@email.com"
Expand All @@ -62,6 +83,12 @@ Sync from coinbase and Ethereum
crypto-sync sync --destination pc coinbase ether
```

Sync from all holding positions in config file

```bash
crypto-sync sync --destination pc all
```

### Sync Command

```bash
Expand Down
19 changes: 19 additions & 0 deletions config.example.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,25 @@ onHoldingNotFound = "zeroQuantity"
symbolName = "USDC"
fullName = "USD Coin"
decimals = 6
[holdings.coinbasepro]
debug = true
[[holdings.coinbasepro.portfolios]]
name = "default_portfolio"
secret = "some_secret"
key = "some_key"
passphrase = "some_pass_phrase"
# If base_url is left blank with default to the value below
base_url = "https://api.pro.coinbase.com"
[holdings.bscscan]
apiKey = "some-api-key"
debug = false
# If base_url is defaulted to the below url
# base_url = "https://api.bscscan.com/api?"
[[holdings.bscscan.account]]
address = "0xaddress"
symbolName = "BNB"
fullName = "Binance Coin"
decimals = 18
[destinations]
[destinations.personalcapital]
email = "example@email.com"
Expand Down

0 comments on commit f8a1bda

Please sign in to comment.