From 62c58d0cbf9861fb44092209152bd94ad8e7f6cf Mon Sep 17 00:00:00 2001 From: William Flores Date: Sun, 28 Mar 2021 15:32:53 -0700 Subject: [PATCH] docs: update readme --- README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 63 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index aef9032..227c016 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,91 @@ ![Go](https://github.com/will7200/go-crypto-sync/workflows/Go/badge.svg) + # Crypto Sync + Sync your Cryptocurrency to a Personal Capital Account + ## Supported Cryptocurrency Holdings + 1. Coinbase +2. Ethereum via etherscan ## Example Commands + 1. Sync your Coinbase to your Personal Capital - + Sample Config + ```toml +# config.example.toml debug = false destination = "personalcapital" priceDataSource = "coinbase" destinationCurrencyAs = "USD" onHoldingNotFound = "zeroQuantity" [holdings] - [holdings.coinbase] - apiKey = "your-key" - apiSecret = "your-secret" - debug = false +[holdings.coinbase] +apiKey = "your-key" +apiSecret = "your-secret" +debug = false +[holdings.ether] +apiKey = "your-key" +debug = false +[[holdings.ether.account]] +address = "your-address" +symbolName = "ETH" +fullName = "Ethereum" +decimals = 18 +[[holdings.ether.account]] +address = "your-address" +contractAddress = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" +symbolName = "USDC" +fullName = "USD Coin" +decimals = 6 [destinations] - [destinations.personalcapital] - email = "example@email.com" - password = "password" - accountName = "CryptoSync managed automatically" +[destinations.personalcapital] +email = "example@email.com" +password = "password" +accountName = "CryptoSync managed automatically" ``` + Commands to Execute + +Sync only from coinbase + ```bash crypto-sync sync --destination pc coinbase ``` +Sync from coinbase and Ethereum + +```bash +crypto-sync sync --destination pc coinbase ether +``` + +### Sync Command + +```bash +Usage: crypto-sync.exe sync ... + +Sync holdings to another account + +Arguments: + ... Holdings to fetch from + +Flags: + --help Show context-sensitive help. + --debug Enable debug mode. + --file-name="config.toml" File to read conf from + + --destination=STRING Sync to Destination + +``` + ## Tools Required to + 1. OpenAPI Generator -The one used for this project is from [here](https://openapi-generator.tech/docs/installation) + The one used for this project is from [here](https://openapi-generator.tech/docs/installation) + ```bash npm install @openapitools/openapi-generator-cli -g ``` \ No newline at end of file