From 77abde73b4f0edd222cff686c5edab92f214dd14 Mon Sep 17 00:00:00 2001 From: Alex Ellis Date: Sat, 3 Feb 2018 21:44:29 +0000 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index ead6da0..c90380d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: