From ab510770f539e934c73988cb72f4682712c74a02 Mon Sep 17 00:00:00 2001 From: Sergey Maskalik Date: Sat, 22 Feb 2020 16:32:46 -0800 Subject: [PATCH] Update readme --- README.MD | 43 +++++++++++++++++++++++++++++++++++++------ 1 file changed, 37 insertions(+), 6 deletions(-) diff --git a/README.MD b/README.MD index ee6a05a..af019c8 100644 --- a/README.MD +++ b/README.MD @@ -15,20 +15,51 @@ were successfully enqueued to the destination. ## Installation -On macOS, Linux, or OpenBSD run the following: +You can install the pre-compiled binary (in several different ways) or compile from source. +### Install the pre-compiled binary + +*homebrew tap* (only on macOS for now): ``` -curl https://raw.githubusercontent.com/mercury2269/sqsmover/master/install.sh | sh +brew install mercury2269/homebrew-tap/sqsmover ``` -Note that you may need to run the `sudo` version below, or alternatively chown `/usr/local`: +*Shell script:* + +The following script will install the binary into `usr/local/bin` + +```sh +$ curl https://raw.githubusercontent.com/mercury2269/sqsmover/master/install.sh | sh ``` -curl https://raw.githubusercontent.com/mercury2269/sqsmover/master/install.sh | sudo sh + +Note that you may need to run the `sudo` version below, or alternatively chown `/usr/local/bin`: +```sh +$ curl https://raw.githubusercontent.com/mercury2269/sqsmover/master/install.sh | sudo sh ``` -On Windows download a zip file with [binary](https://github.com/mercury2269/sqsmover/releases). +**manually (including Windows)**: + +Download the pre-compiled binaries from the [releases page][releases] and +copy to the desired location. + +### Compiling from source -After downloading, rename the binary file to 'sqsmover.exe', and add to PATH. +You will need to have [Golang installed](https://golang.org/doc/install). + +```sh +# clone it outside GOPATH +git clone https://github.com/mercury2269/sqsmover +cd sqsmover + +# get dependencies using go modules (needs go 1.11+) +go get ./... + +# build +go build -o sqsmover . + +# check it works +./sqsmover --version +``` ## Configuring Credentials Before using SQS Mover ensure that you've configured AWS credentials. The best