Skip to content
This repository has been archived by the owner on Mar 7, 2020. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexellis committed Feb 3, 2018
1 parent 79ae99b commit 77abde7
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,11 @@ Features:
* Configure the algorithm and port i.e. hodl or cryptonight
* Atom hosts are supported through a separate Docker image

The config file is read from `config.yml`, so copy `config.example.yml` as a template and fill in your [Packet API key and project ID](https://www.packet.net/developers/api/). Set the `CONFIG_FILE` enviromental variable for a different filename or path. You must also configure the bitcoin wallet address for your mining here.
## Q&A

```yaml
packet:
project_id: ""
api_key: ""
preferences:
max_spot_instances: 6
max_price: 0.15
mine_algo: "cryptonight"
port: 3355
bitcoin_wallet: wallet_address
```
* [Watch my video on why you shouldn't mine Bitcoin](https://www.youtube.com/watch?v=Apg8glATeto)

If you have additional questions or you want to try mining but don't want to use this example then consult my [mine-with-docker project](https://github.com/alexellis/mine-with-docker). You can also rebuild your own Docker image/binaries from source.

## Installation

Expand All @@ -44,9 +36,20 @@ go install github.com/alexellis/spotminer

This installs spotminer into your `$GOPATH/bin` directory, so update your `$PATH` variable if necessary. `$GOPATH` is normally set to `$HOME/go`.

## Q&A

For any questions please consult my [mine-with-docker project](https://github.com/alexellis/mine-with-docker)
The config file is read from `config.yml`, so copy `config.example.yml` as a template and fill in your [Packet API key and project ID](https://www.packet.net/developers/api/). Set the `CONFIG_FILE` enviromental variable for a different filename or path. You must also configure the bitcoin wallet address for your mining here.

```yaml
packet:
project_id: ""
api_key: ""
preferences:
max_spot_instances: 6
max_price: 0.15
mine_algo: "cryptonight"
port: 3355
bitcoin_wallet: wallet_address
```

## Packages:

Expand Down

0 comments on commit 77abde7

Please sign in to comment.